Skip to content

Commit e661b0b

Browse files
author
Waren Gonzaga
committed
Better documentation
1 parent c3fa367 commit e661b0b

File tree

1 file changed

+47
-5
lines changed

1 file changed

+47
-5
lines changed

README.md

Lines changed: 47 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,41 +58,75 @@ curl https://covid19tracker.xyz
5858
wget -i https://covid19tracker.xyz && cat index.html
5959
```
6060

61+
#### HTTPie
62+
63+
```bash
64+
# visit httpie.org
65+
http http://covid19tracker.xyz
66+
```
67+
6168
### Country Tracking
6269

6370
To track COVID-19 cases on CLI by country, all you need to do is to append the URL with the country name or country [ISO 3166-1](https://warengonza.ga/iso-3166-1-codes) code.
6471

6572
#### Country Name
6673

6774
```bash
75+
# example usage
6876
curl https://covid19tracker.xyz/philippines
6977
```
7078

7179
#### Country ISO 3166-1 Code
7280

7381
```bash
82+
# /ph or /phl is ISO 3166 code of the Philippines
7483
curl https://covid19tracker.xyz/ph
7584
```
7685

7786
#### Country with History Chart
78-
```/history/<country>/``` or append with ```<cases or deaths>```
79-
8087

8188
```bash
89+
# shows result with history chart
8290
curl https://covid19tracker.xyz/history/ph
8391
```
8492

8593
```bash
94+
# shows by default a history chart
8695
curl https://covid19tracker.xyz/history/ph/cases
8796
```
8897

8998
```bash
99+
# shows result with history chart
90100
curl https://covid19tracker.xyz/history/ph/deaths
91101
```
92102

103+
## Advance Usage
104+
105+
### Check Update Automagically
106+
107+
```bash
108+
# check update every 10 seconds (where -n 10 is the interval)
109+
watch -n 10 curl https://covid19tracker.xyz
110+
```
111+
112+
### Create a Shortcut Command
113+
114+
```bash
115+
# set a desired alias for the command (replace endcov with your desired alias)
116+
# this will give you a global update
117+
# alias <your alias>="curl https://covid19tracker.xyz"
118+
119+
alias endcov="curl https://covid19tracker.xyz"
120+
121+
# if you want to track a specific country
122+
# alias <your alias><your coutry alias>="curl https://covid19tracker.xyz/<country name, ISO2, ISO3 here>"
123+
124+
alias endcovPH="curl https://covid19tracker.xyz/philippines"
125+
```
126+
93127
## Official Blog
94128

95-
Many people asking me how to properly use my tracker. Here's the blog on [How to Track Coronavirus on Command Line](https://warengonza.ga/covid19-tracker-cli).
129+
Many people asking me how to properly use my tracker. Here's the blog on [How to Track Coronavirus on Command Line](https://warengonza.ga/covid19-tracker-cli). If you have comments or suggestions please leave it on the comment section of the blog.
96130

97131
## Screenshots
98132

@@ -115,7 +149,7 @@ Working on it...
115149

116150
## Contributing
117151

118-
Contributions are welcome, create a pull request to this repo and I will review your code.
152+
Contributions are welcome, create a pull request to this repo and I will review your code. Please consider to submit your pull request to the ```dev``` branch. Thank you!
119153

120154
## Issues
121155

@@ -161,10 +195,18 @@ COVID-19 Tracker CLI is licensed under MIT - <https://opensource.org/licenses/MI
161195

162196
* API from [NovelCOVID API](https://github.com/NovelCOVID/API) which based on [WorldMeter](https://www.worldometers.info/coronavirus)
163197

198+
* Data from [CSSE at Johns Hopkins University](https://github.com/CSSEGISandData)
199+
164200
## Related Projects
165201

166202
* <https://github.com/sagarkarira/coronavirus-tracker-cli>
167203

204+
## Other Projects
205+
206+
* [WiFi Passview](https://github.com/warengonzaga/wifi-passview) is an open-source batch script-based program that can recover your WiFi Password easily in seconds.
207+
208+
* [WRN Cleaner](https://github.com/warengonzaga/wrn-cleaner) is an all in one batch script based native PC maintenance and cleaner for Windows.
209+
168210
## Resources
169211

170212
* <https://github.com/soroushchehresa/awesome-coronavirus>
@@ -181,4 +223,4 @@ COVID-19 Tracker CLI is Developed and Maintained by **Waren Gonzaga** and **Ian
181223

182224
---
183225

184-
**</>** with **<3** by **Waren Gonzaga**
226+
**</your>** with **<3** by **Waren Gonzaga**

0 commit comments

Comments
 (0)