Skip to content

Commit 48bd188

Browse files
authored
readme changes
1 parent 79698fe commit 48bd188

File tree

1 file changed

+53
-69
lines changed

1 file changed

+53
-69
lines changed

readme.md

Lines changed: 53 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,67 @@
1-
# coronavirus-tracker-cli [![Build Status](https://github.com/sagarkarira/coronavirus-tracker-cli/workflows/Tests/badge.svg)](https://github.com/sagarkarira/coronavirus-tracker-cli/actions?workflow=Tests)
1+
<h1 align="center">
2+
Coronavirus Tracker CLI
3+
</h1>
24

3-
Track The Corona virus from your CLI
5+
Track The Corona virus stats from your terminal using curl or global command.
6+
7+
[![Build Status](https://github.com/sagarkarira/coronavirus-tracker-cli/workflows/Tests/badge.svg)](https://github.com/sagarkarira/coronavirus-tracker-cli/actions?workflow=Tests)
8+
[![Tweet](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fsagarkarira%2Fcoronavirus-tracker-cli%2F)](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fsagarkarira%2Fcoronavirus-tracker-cli%2F)
9+
10+
11+
**Live global stats (provided by [fight-covid19/bagdes](https://github.com/fight-covid19/bagdes)) from this API:**
12+
13+
![Covid-19 Confirmed](https://covid19-badges.herokuapp.com/confirmed/latest)
14+
![Covid-19 Deaths](https://covid19-badges.herokuapp.com/deaths/latest)
415

516
## Screenshot
617

718
![Preview](./preview.png)
819

9-
## CURL
20+
## Data Sources
1021

11-
### Complete Data
22+
* Source 1 : [John Hopkins Data API](https://github.com/ExpDev07/coronavirus-tracker-api)
23+
* Source 2 : [WorldoMeters Data API](https://github.com/NovelCOVID/API/) updated very frequently.
1224

13-
```sh
14-
curl https://corona-stats.online
15-
```
25+
**Note: Source 2 is the default source now if not mentioned**
1626

17-
### Filter by Country Stats
27+
## CURL
1828

1929
```sh
20-
curl https://corona-stats.online/<country>
21-
```
30+
# Get data from worldometers api i.e source 2
31+
curl https://corona-stats.online
2232

23-
where \<country\> can be a country name or its ISO code.
33+
# Get data from source 1
34+
curl https://corona-stats.online?source=1
2435

25-
* US: `curl https://corona-stats.online/US`
26-
* Italy: `curl https://corona-stats.online/Italy`
27-
* UK: `curl https://corona-stats.online/UK` or `curl https://corona-stats.online/GB`
36+
# Get data from source 2
37+
curl https://corona-stats.online?source=2
2838

29-
### Minimal Compact Table
39+
# Filter by country /countryCode or /countryName
3040

31-
```sh
32-
curl https://corona-stats.online?minimal=true
33-
```
34-
35-
### Only show top N countries
41+
curl https://corona-stats.online/US
42+
curl https://corona-stats.online/italy
43+
curl https://corona-stats.online/uk?source=2
44+
curl https://corona-stats.online/gb?source=1
3645

37-
```sh
46+
# Only show top N countries
3847
curl https://corona-stats.online?top=20
39-
```
40-
### Get JHU data (source 2 is now the default source)
4148

42-
```sh
43-
curl https://corona-stats.online?source=1
44-
```
49+
# Remove padding and borders from table
50+
curl https://corona-stats.online?minimal=true
4551

46-
### Latest News (Work in Progress)
4752

48-
```sh
53+
# Latest News (Work In Progress)
4954
curl https://corona-stats.online/updates
55+
56+
# Help
57+
curl https://corona-stats.online/help
58+
5059
```
5160

5261
## API
5362

5463
Add `?format=json` at the end of any API to get JSON formatted data.
5564

56-
### Example
57-
5865
```sh
5966
curl https://corona-stats.online?format=json
6067
```
@@ -66,58 +73,41 @@ Note: NodeJS version 12 recommended. You can download it [here](https://nodejs.o
6673
**Install**
6774

6875
``` sh
76+
# Install
6977
npm install coronavirus-tracker-cli -g
70-
```
71-
72-
### Run command
7378

74-
```sh
75-
corona
76-
```
77-
78-
### Filter by country
79-
80-
```sh
81-
corona italy
82-
```
83-
84-
### Get JHU data (source 2 is now the default source)
79+
# Run command
80+
corona
8581

86-
```sh
82+
# Get source 1 data
8783
corona --source=1
88-
```
8984

90-
### Top N countries
85+
# Filter by country
86+
corona italy
9187

92-
```sh
88+
# Filter top N countries
9389
corona --top=10
94-
```
95-
96-
### With emojis
9790

98-
```sh
99-
corona --emojis
100-
```
101-
102-
### Set Minimal Compact Table
103-
104-
```sh
91+
# Minimal Compact Table
10592
corona --minimal
106-
```
107-
108-
### Disable colors
10993

110-
```sh
94+
# Monocolor / No colors
11195
corona --color=false
96+
97+
# Show emojis
98+
corona --emojis
99+
112100
```
113101

114102
## ToDos
115103

116104
* ~~Filter by country to get cases by local states.~~
117105
* ~~Move from npm to curl~~
118106
* ~~Add daily change.~~
119-
* Add growth rate. (linear regression)
107+
* ~~Add graphs~~
108+
* Add growth rate column ? (double in X days)
120109
* Add latest updates from reddit / twitter.
110+
* Find and add regional data - state, county, city, district level data.
121111

122112
## Contributors
123113

@@ -147,12 +137,6 @@ corona --color=false
147137
* [Philippines](https://ncovtracker.doh.gov.ph/)
148138
* [Austria (official)](https://info.gesundheitsministerium.at), [Austria (inofficial but more detailed)](https://covid19.spiessknafl.at)
149139

150-
## Data Sources
151-
152-
* [John Hopkins Data](https://github.com/CSSEGISandData/COVID-19) updated once a day at 11:59 UTC
153-
* [John Hopkins Data API](https://github.com/ExpDev07/coronavirus-tracker-api)
154-
* [WorldoMeters Data API](https://github.com/NovelCOVID/API/) updated very frequently.
155-
156140
## Related Projects
157141

158142
* <https://github.com/NovelCOVID/API>

0 commit comments

Comments
 (0)