From aeb94f4fec57c699c11106de9678fd90218dc1c2 Mon Sep 17 00:00:00 2001 From: JOLIMAITRE Matthieu Date: Fri, 12 Apr 2024 17:45:11 +0200 Subject: [PATCH] update readme example --- README.md | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 02499b1..319adea 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,31 @@ Compte vos OKIs. ## Usage -1. Aller chercher un token sur le gitlab concerné. +1. Télécharger ce programme. -- disponible sur https://gitlab.cri.epita.fr/-/user_settings/personal_access_tokens +```sh +wget https://git.barnulf.net/mb/okimeter/releases/download/latest/okimeter +chmod a+x okimeter +``` + +2. Aller chercher un token sur le gitlab concerné. + +- disponible sur [cette page gitlab](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]` +```sh +./okimeter +# fetching api/v4/merge_requests?per_page=100&page=1 +# fetching api/v4/merge_requests?per_page=100&page=2 +# fetching api/v4/projects/1/merge_requests/2/notes?per_page=100&page=1 +# fetching api/v4/projects/2/merge_requests/1/notes?per_page=100&page=1 +# fetching api/v4/projects/3/merge_requests/1/notes?per_page=100&page=1 +# fetching api/v4/projects/4/merge_requests/1/notes?per_page=100&page=1 +# fetching api/v4/projects/1/merge_requests/1/notes?per_page=100&page=2 +# fetching api/v4/projects/2/merge_requests/1/notes?per_page=100&page=2 +# fetching api/v4/projects/3/merge_requests/2/notes?per_page=100&page=2 +# fetching api/v4/projects/4/merge_requests/1/notes?per_page=100&page=2 +Total 'oki' 14 +```