Add usage to readme file

This commit is contained in:
Michael De Roover 2020-08-04 23:44:32 +02:00
parent a725e54772
commit 9f9c4b0c02
Signed by: vim
GPG Key ID: 075496E232CE04CB

View File

@ -14,6 +14,8 @@ This application depends on `jq` to parse the JSON output from corona.lmao.ninja
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`. 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`.
From the cloned repository you can run the application using `./cv [country]`, e.g. `cv Belgium`. For worldwide stats you can use `./cv all`. If you wouldn't want to type out your country every time, you can pass an environment variable `$COUNTRY`. So something like `COUNTRY=Belgium ./cv` would work too. In that case it would be best to load this variable from file (such as `/etc/environment`, `~/.bashrc` or similar).
#### Data Collection #### 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. This program does not track any personal data or contact my servers to function. You can read the source code to confirm this.