diff --git a/README.md b/README.md index 523e74c..66d6811 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,58 @@ -# gestion-perso -Un bot gestion fais en solo +# Gestion + +![Logo du Bot](readme/PPgestionBot.png) + +## Description + +Le Bot Discord Gestion est un bot multifonction développé en JavaScript utilisant la bibliothèque Discord.js. Il est conçu pour offrir diverses fonctionnalités utiles pour les serveurs Discord. + +## Fonctionnalités + +- **Commandes de base :** Commandes telles que !help, !ping, etc. +- **Modération :** Commandes de modération pour gérer les utilisateurs et les messages. +- **Fun :** Commandes amusantes pour divertir les membres du serveur. +- **Musique :** Lecture de musique depuis YouTube et autres plateformes. + +## Installation + +1. Cloner le référentiel : + +```bash +git clone https://github.com/votre_utilisateur/nom-du-bot.git +``` + +2. Installer les dépendances : + +``` +cd nom-du-bot +npm install +``` + +3. Ajouter le fichier .env avec votre token bot. + +``` +TOKEN=votre_token_ici +``` + +4. Lancer le bot : + +```js +node main.js +``` + +## Contribuer + +Si vous souhaitez contribuer à ce projet, suivez ces étapes : + +1. Fork du projet +2. Créer une branche pour votre fonctionnalité (git checkout -b fonctionnalite/ma-fonctionnalite) +3. Commit de vos modifications (git commit -am 'Ajout de la fonctionnalité ma-fonctionnalite') +4. Push vers la branche (git push origin fonctionnalite/ma-fonctionnalite) +5. Ouvrir une Pull Request + +## Auteurs +tutur33 - Développeur principal + +## Licence + +Ce projet est sous licence Apache 2.0. Consultez le fichier LICENSE pour plus de détails. diff --git a/readme/PPgestionBot.png b/readme/PPgestionBot.png new file mode 100644 index 0000000..b11649e Binary files /dev/null and b/readme/PPgestionBot.png differ