vim
/
cv
Archived
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add a README file

This commit is contained in:
Michael De Roover 2020-08-04 23:39:15 +02:00
parent 8c9b053b44
commit a725e54772
Signed by: vim
GPG Key ID: 075496E232CE04CB
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md Normal file
View File

@ -0,0 +1,21 @@
#### A COVID-19 tracker using the corona.lmao.ninja API
This is a COVID-19 tracker for Linux, allowing you to track, review and save statistics for your country, others or worldwide.
The data files are retrieved from corona.lmao.ninja which in turn receives its data from the Johns Hopkins University over at [GitHub](https://github.com/CSSEGISandData/COVID-19). Basically every application uses these, and I am also cross-verifying this. So far all the data appears consistent, although the stats from this program are more detailed than most others.
I wrote this application mostly to get as much data as possible and present it in a clean manner. I hope you'll enjoy using it too.
#### Dependencies
This application depends on `jq` to parse the JSON output from corona.lmao.ninja. Most distributions provide this program from their repositories.
#### Installation
You can clone this repository to your computer using `git clone https://git.ghnou.su/ghnou/cv`. Afterwards you can run cv directly from it, without needing to install it. If you would like to install it, you can copy the program to `/usr/local/bin` or `~/.local/bin`.
#### Data Collection
This program does not track any personal data or contact my servers to function. You can read the source code to confirm this.
The API responses from corona.lmao.ninja are saved to your local machine for subsequent data retrievals in `~/Documents/cv`. This could be used to review stats from earlier days, and I'd like to implement a time-series view using these in the future.