diff --git a/README.md b/README.md new file mode 100644 index 0000000..02499b1 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# OKImeter + +Compte vos OKIs. + +## Usage + +1. Aller chercher un token sur le gitlab concerné. + +- disponible sur https://gitlab.cri.epita.fr/-/user_settings/personal_access_tokens +- pendant la création, cocher au moins `read_api` + +2. Télécharger ce programme. + +- lien de téléchargement : https://git.barnulf.net/mb/okimeter/releases/download/latest/okimeter +- `chmod a+x okimeter` + +3. Exécuter ce programme avec le token récupéré. + +- `./okimeter [TOKEN]`