diff --git a/README.md b/README.md index f1fdd49..0ba4bcc 100644 --- a/README.md +++ b/README.md @@ -1 +1,68 @@ -# BreadcrumbsDiscord-Bot-Gestion-python +# Bot Discord Gestion + +## Introduction + +Bienvenue sur le Bot Discord Gestion ! Ce bot est conçu pour faciliter la gestion de votre serveur Discord en fournissant diverses fonctionnalités utiles. + +## Configuration + +Avant de commencer à utiliser le bot, veuillez suivre ces étapes de configuration : + +1. Clonez le référentiel sur votre machine locale : + + ```bash + git clone https://github.com/Tutur33/Discord-Bot-Gestion-python.git + ``` + +2. Ajoutez un dossier `db` à la racine du projet : + + ```bash + mkdir db + ``` + +3. Créez un fichier `.env` dans le répertoire racine et ajoutez votre token Discord comme suit : + + ```plaintext + TOKEN=your_token + ``` + + Remplacez `your_token` par le token réel de votre bot Discord. + +## Installation des dépendances + +Pour installer les dépendances nécessaires, utilisez la commande suivante : + +```bash +pip install -r requirements.txt +``` + +## Utilisation + +1. Exécutez le bot en utilisant la commande suivante : + + ```bash + python main.py + ``` + +2. Invitez le bot sur votre serveur Discord. + +3. Commencez à utiliser les commandes pour gérer votre serveur ! + +## Commandes + +Voici quelques exemples de commandes que vous pouvez utiliser avec le bot : + + +- `/help` - Affiche une liste des commandes disponibles et leurs descriptions. +- `/config` - Permet de configurer les paramètres du bot. +- ... + +## Contributions + +Les contributions sont les bienvenues ! Si vous souhaitez contribuer à l'amélioration de ce bot, n'hésitez pas à créer une pull request. + +## Auteur + +Créé par [TuturP33](https://github.com/Tutur33). + +Merci d'utiliser le Bot Discord Gestion ! \ No newline at end of file