From 8ff719f01eede87deaaea08c35aab634156649d4 Mon Sep 17 00:00:00 2001 From: Mylloon Date: Thu, 29 Jul 2021 00:56:22 +0200 Subject: [PATCH] Better Readme --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index abb0798..63d0f48 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ ## Setup and Run +### Locally + Requires Python `3.9.5`. Install necessary packages: @@ -13,11 +15,11 @@ python3 -m pip install -r requirements.txt Rename `.envexample` file in `.env` inside `src` folder, then open the file and complete the fields, there is an explanation below: | Field | Explanation | -|----------------|-----------------------------------------------------------------------------------------------------------| +|----------------|-------------| | `ACCESS_TOKEN` | Access token of the account you created for your bot that you can take [here](https://twitchtokengenerator.com/) (be sure you selected Bot Chat Token) | | `PREFIX` | Prefix you want to use for your bot | | `CHANNEL` | The name of the your Twitch channel you want the bot to run at (separate by comma) | -| `DISCORD` | Link to your discord server | +| `DISCORD` | Link to your discord server | Start Bot: @@ -26,7 +28,7 @@ cd src python3 main.py ``` -## Use Docker +### With Docker With a [docker-compose](https://gitlab.com/ConfrerieDuKassoulait/Bot-Tom/-/blob/main/docker-compose.yml) or in command line: @@ -39,3 +41,15 @@ docker run -d \ --CHANNEL="yourChannel(s)" \ --DISCORD="yourDiscordLink" ``` + +## Features + +Here the list of available commands by default: + +| Command | Explanation | +|-----------|-------------| +| `discord` | Envoie le lien de ton serveur Discord | +| `add` | Ajoute une commande de la base de donnée du bot : `add` `omDeLaCommande` `messageDeLaCommande` | +| `remove` | Supprime une commande de la base de donnée du bot : `remove` `nomDeLaCommande` | +| `list` | Affiche la liste des commandes de la base de donnée du bot | +| `edit` | Modifie une commande de la base de donnée du bot : `add` `nomDeLaCommande` `nouveauMessageDeLaCommande` |