From 7a0ef2668430394786d3cc18c6d0065134cd48be Mon Sep 17 00:00:00 2001
From: JOLIMAITRE Matthieu <matthieu@imagevo.fr>
Date: Fri, 12 Apr 2024 17:40:19 +0200
Subject: [PATCH] add readme

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 README.md

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]`