diff --git a/README.md b/README.md index b04b7d3..17c28e4 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# COVID-19 Tracker & CLI [![Mentioned in Awesome Coronavirus](https://awesome.re/mentioned-badge-flat.svg)](https://github.com/soroushchehresa/awesome-coronavirus) +# COVID-19 Tracker & CLI [![mentioned in awesome coronavirus](https://awesome.re/mentioned-badge-flat.svg)](https://github.com/soroushchehresa/awesome-coronavirus) [![huntr](https://cdn.huntr.dev/huntr_security_badge_mono.svg)](https://huntr.dev) [![created by](https://img.shields.io/badge/created%20by-Waren%20Gonzaga-blue.svg?longCache=true&style=flat-square)](https://github.com/warengonzaga) [![maintained by](https://img.shields.io/badge/maintained%20by-Wareneutron%20Developers-blue.svg?longCache=true&style=flat-square)](https://wareneutron.com) [![Build](https://img.shields.io/circleci/build/github/wareneutron/covid19-tracker-cli/main?style=flat-square)](https://github.com/wareneutron/covid19-tracker-cli) [![Release](https://img.shields.io/github/release/wareneutron/covid19-tracker-cli.svg?style=flat-square)](https://github.com/wareneutron/covid19-tracker-cli/releases) [![Star](https://img.shields.io/github/stars/wareneutron/covid19-tracker-cli.svg?style=flat-square)](https://github.com/wareneutron/covid19-tracker-cli/stargazers) [![License](https://img.shields.io/github/license/wareneutron/covid19-tracker-cli.svg?style=flat-square)](https://github.com/wareneutron/covid19-tracker-cli/blob/main/LICENSE) [![Banner](.github/wareneutron_covid19_tracker_cli_github_banner.png)](https://docs.wareneutron.com/covid19-tracker-cli) -**COVID-19 Tracker and CLI** is an open-source NodeJS application for command line interface to track COVID-19 cases around the world. An optimized NodeJS application and a simple tracker with real-time updates from reliable data source. It Supports terminal for linux and macos, command prompt for windows, and termux for android. +**COVID-19 Tracker & CLI** is an open-source NodeJS application for command line interface to track COVID-19 cases around the world. An optimized NodeJS application and a simple tracker with real-time updates from reliable data source. It Supports terminal for linux and macos, command prompt for windows, and termux for android. ## 😎 Demo @@ -14,37 +14,33 @@ Let's see it in action! ## 📖 Documentation - -The complete documentation can be found here:
-[![Docs](https://img.shields.io/badge/Docs-docs.wareneutron.com/covid19--tracker--cli-blue.svg?longCache=true&style=for-the-badge)](https://docs.wareneutron.com/covid19-tracker-cli) - +The complete documentation can be found here: + +[![docs](https://img.shields.io/badge/Docs-docs.wareneutron.com/covid19--tracker--cli-blue.svg?longCache=true&style=for-the-badge)](https://docs.wareneutron.com/covid19-tracker-cli) ## 🎯 Contributing -Contributions are welcome, create a pull request to this repo and we'll review your code. Please consider to submit your pull request to the ```dev``` branch. Thank you! +Contributions are welcome, create a pull request to this repo and we'll review your code. Please consider submitting your pull request to the ```dev``` branch. Thank you! + +Read the project's [contributing guide](./contributing.md) for more info. ## 🐛 Issues -If you're facing a problem in using COVID-19 Tracker and CLI please let us know by [creating an issue here](https://github.com/wareneutron/covid19-tracker-cli/issues/new). We are happy to help you! Don't forget to provide us some screenshot or errors of it, thank you! +If you're facing a problem in using COVID-19 Tracker & CLI please let us know by [creating an issue here](https://github.com/wareneutron/covid19-tracker-cli/issues/new). We are happy to help you! Don't forget to provide us some screenshot or errors of it, thank you! ## 🏆 Sponsors and Supporters -[![Vercel](https://wrngnz.ga/badge-vercel)](https://vercel.com) [![CircleCI](https://wrngnz.ga/badge-circleci)](https://circleci.com) [![GitBook](https://wrngnz.ga/badge-gitbook)](https://gitbook.io) [![Digital Ocean](https://wrngnz.ga/badge-digitalocean)](https://digitalocean.com) [![Netlify](https://wrngnz.ga/badge-netlify)](https://netlify.com) +[![vercel](https://wrngnz.ga/badge-vercel)](https://vercel.com) [![circleci](https://wrngnz.ga/badge-circleci)](https://circleci.com) [![gitbook](https://wrngnz.ga/badge-gitbook)](https://gitbook.io) [![digital ocean](https://wrngnz.ga/badge-digitalocean)](https://digitalocean.com) [![netlify](https://wrngnz.ga/badge-netlify)](https://netlify.com) - -> Love what we do? **[Send us some coffees](https://buymeacoff.ee/wareneutron)**!
+> Love what we do? **[Send us some coffees](https://buymeacoff.ee/wareneutron)**! +> > Your coffee donation and support will help us to continue working on open-source projects like this. - ## 🌏 Community Wanna become one of us? Join today and contribute! -[![Community](https://discordapp.com/api/guilds/694612151444439081/widget.png?style=banner3)](https://wareneutron.com/discord) - -Looking for community of Filipino tech enthusiasts? - -[![Community](https://discordapp.com/api/guilds/659684980137656340/widget.png?style=banner2)](https://wrngnzga.com/discord) +[![community](https://discordapp.com/api/guilds/694612151444439081/widget.png?style=banner2)](https://wareneutron.com/discord) [![community](https://discordapp.com/api/guilds/659684980137656340/widget.png?style=banner2)](https://wrngnz.ga/discord) ## 📋 Code of Conduct @@ -52,11 +48,11 @@ Read the project's [code of conduct](./code_of_conduct.md). ## 📃 License -COVID-19 Tracker and CLI is licensed under [GNU General Public License v3](https://opensource.org/licenses/GPL-3.0). +COVID-19 Tracker & CLI is licensed under [GNU General Public License v3.0](https://opensource.org/licenses/GPL-3.0). ## 📝 Author -COVID-19 Tracker and CLI is created by **[Waren Gonzaga](https://github.com/warengonzaga)**, developed and maintained by [Wareneutron Developers](https://wareneutron.com) with the help of awesome [contributors](https://github.com/wareneutron/covid19-tracker-cli/graphs/contributors). +COVID-19 Tracker & CLI is created by **[Waren Gonzaga](https://github.com/warengonzaga)**, developed and maintained by [Wareneutron Developers](https://wareneutron.com) with the help of awesome [contributors](https://github.com/wareneutron/covid19-tracker-cli/graphs/contributors). --- diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..0f9f9f6 --- /dev/null +++ b/contributing.md @@ -0,0 +1,31 @@ +# 🎯 Contributing to COVID-19 Tracker & CLI + +Any contributions are welcome, encouraged, and valued. See the following information below for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for me as maintainer and smooth out the experience for all involved. The community looks forward to your contributions. 🎉✌✨ + +## 📋 Code of Conduct + +This project and everyone participating in it is governed by the COVID-19 Tracker & CLI [Code of Conduct](https://github.com/wareneutron/covid19-tracker-cli/blob/main/code_of_conduct.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to . + +## 💖 How to Contribute + +There are many ways to contribute to this open source project. Any contributions are welcome and appreciated. Be sure to read the details of each section for you to start contributing. + +### 🧬 Development + +If you can write a code then create a pull request to this repo and I will review your code. Please consider to submit your pull request to the ```dev``` branch. I will auto reject if you submit your pull request to the ```main``` branch. + +### 📖 Documentation + +(coming soon) + +### 🧰 Support + +Answering a question in [Discussions](https://github.com/wareneutron/covid19-tracker-cli/discussions) is one of the easiest ways to start contributing. + +### 🐞 Reporting Bugs + +For any security bugs or issues, please read the [security policy](./security.md). + +--- + +💻 Made with 💖 and ☕ by [Wareneutron Developers](https://wareneutron.com) diff --git a/SECURITY.md b/security.md similarity index 100% rename from SECURITY.md rename to security.md