From 9f9c4b0c024b821bcb5e59d4243933d07ca038f2 Mon Sep 17 00:00:00 2001 From: Michael De Roover Date: Tue, 4 Aug 2020 23:44:32 +0200 Subject: [PATCH] Add usage to readme file --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 5b17a3a..126135f 100644 --- a/README.md +++ b/README.md @@ -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`. +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 This program does not track any personal data or contact my servers to function. You can read the source code to confirm this.