Skip to content

Commit 9e42f84

Browse files
author
Waren Gonzaga
committed
Improve README file
1 parent 3346850 commit 9e42f84

File tree

1 file changed

+108
-2
lines changed

1 file changed

+108
-2
lines changed

README.md

Lines changed: 108 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,108 @@
1-
# covid19-tracker-cli
2-
Track COVID-19 cases from command line interface. curl https://covid19tracker.xyz/
1+
# COVID-19 Tracker CLI [![Developed by Waren Gonzaga](https://img.shields.io/badge/Developed%20by-Waren%20Gonzaga-blue.svg?longCache=true&style=for-the-badge)](https://facebook.com/warengonzagaofficial)
2+
3+
<!--[![Github Release](https://img.shields.io/github/release/warengonzaga/covid19-tracker-cli.svg?style=for-the-badge)](https://github.com/warengonzaga/covid19-tracker-cli/releases)-->
4+
[![Github Star](https://img.shields.io/github/stars/warengonzaga/covid19-tracker-cli.svg?style=for-the-badge)](https://github.com/warengonzaga/covid19-tracker-cli)
5+
[![Github Fork](https://img.shields.io/github/forks/warengonzaga/covid19-tracker-cli.svg?style=for-the-badge)](https://github.com/warengonzaga/covid19-tracker-cli)
6+
[![License](https://img.shields.io/github/license/warengonzaga/covid19-tracker-cli.svg?style=for-the-badge)](https://github.com/warengonzaga/covid19-tracker-cli)
7+
[![Powered By](https://img.shields.io/badge/Powered%20By-NodeJS-green.svg?style=for-the-badge)](https://gulpjs.com)
8+
9+
**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. [Visit Wiki](https://github.com/warengonzaga/covid19-tracker-cli/wiki)
10+
11+
## Featured By
12+
13+
Wanna feature this project? Let me know!
14+
15+
## How it Works
16+
17+
It uses an API and collect the relevant information for your reference.
18+
19+
> Data Source: <https://www.worldometers.info/coronavirus/>
20+
21+
## Features
22+
23+
This simple application offers you the following features...
24+
25+
* Real-Time udpates.
26+
* Optimized application.
27+
* Simple layout and easy to understand.
28+
29+
_More features coming soon..._
30+
31+
## Usage
32+
33+
To track COVID-19 cases on CLI globally, all you need to do is to use CURL or WGET command.
34+
35+
```bash
36+
curl https://covid19tracker.xyz
37+
```
38+
39+
or
40+
41+
```bash
42+
wget -i https://covid19tracker.xyz && cat index.html
43+
```
44+
45+
_Note: At the moment the country specific data feature is currently under development.
46+
47+
## Screenshots
48+
49+
Here's the screeshot of the tracker on CLI...
50+
51+
![Screenshot](./lib/img/screenshot.jpg)
52+
53+
## White Label / Personalize / Custom / Development
54+
55+
Working on it...
56+
57+
## Contributing
58+
59+
Contributions are welcome, create a pull request to this repo and I will review your code.
60+
61+
## Issues
62+
63+
If you're facing a problem in using COVID-19 Tracker CLI please let me know by creating an issue in this github repository. I'm happy to help you! Don't forget to provide some screenshot or error logs of it!
64+
65+
## To Do
66+
67+
* Improve CLI
68+
* By Country Query
69+
* CI (CircleCI)
70+
* Local Version
71+
* Code Refactor (I don't know what I'm doing)
72+
* More... (have suggestions? let me know!)
73+
74+
## Community
75+
76+
Wanna see other projects I made? Join today!
77+
78+
[![Community](https://discordapp.com/api/guilds/659684980137656340/widget.png?style=banner2)](https://bmc.xyz/l/wgofficialds)
79+
80+
## Donate or Support
81+
82+
If you love this project please consider to support the development by means of coffee. I spend and waste my time just to save your time! Be a sponsor or backer of this project. Just a cup of coffee!
83+
84+
[![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg?style=for-the-badge)](https://paypal.me/warengonzagaofficial)
85+
[![Support](https://img.shields.io/badge/Support-Buy%20Me%20A%20Coffee-orange.svg?style=for-the-badge)](https://www.buymeacoffee.com/warengonzaga)
86+
87+
## Supporters and Backers
88+
89+
* your_name_here
90+
91+
Wanna see your name here? [Just buy me a coffee](https://www.buymeacoffee.com/warengonzaga)!
92+
93+
## License
94+
95+
COVID-19 Tracker CLI is licensed under MIT - <https://opensource.org/licenses/MIT>
96+
97+
## Author
98+
99+
COVID-19 Tracker CLI is Developed and Maintained by **Waren Gonzaga**
100+
101+
* **Facebook:** <https://facebook.com/warengonzagaofficial>
102+
* **Twitter:** <https://twitter.com/warengonzaga>
103+
* **Website:** <https://warengonzaga.com>
104+
* **Email:** dev(at)warengonzaga[.]com
105+
106+
---
107+
108+
**</>** with **<3** by **Waren Gonzaga**

0 commit comments

Comments
 (0)