From 7618f309baa733571cb8843bb6447972df417f92 Mon Sep 17 00:00:00 2001
From: Lendemor <thomas.brandeho@gmail.com>
Date: Sun, 12 May 2024 14:40:30 +0200
Subject: [PATCH] add stuff to README

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index 6cf2f50..eecac0a 100644
--- a/README.md
+++ b/README.md
@@ -5,3 +5,25 @@ Merci à ChatGPT pour m'avoir aidé à porter mon vieux bot IRC en C++, en un bo
 
 Lien du vieux bot IRC que j'avais codé en 2016 : 
 https://git.epicsparrow.com/Anselme/sparrowbot/-/blob/master/app/fourasmodule.cpp
+
+
+# How to run the bot
+
+## Setup env var for the bot
+
+- Create a `.env` file at the root of the project
+- Add the following content to the file:
+    - `DISCORD_TOKEN` : the token of the bot
+    - `GITEA_API_KEY` : the api key to interact with gitea
+    - `GUILD_ID` : the id of the guild where the bot offer slash commands
+
+
+```bash
+python -m main
+```
+
+
+## GITEA API
+Permission needed:
+- repo: read
+- issues: read & write
\ No newline at end of file