diff --git a/README.md b/README.md index e04b533..88cc342 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ -# HoloBotDiscord +
Small Discord bot made on Py-Cord
+ + + +## Installation + +1. Install MongoDB using the [official installation manual](https://www.mongodb.com/docs/manual/installation/). +2. `git clone https://git.end-play.xyz/HoloUA/Discord.git` +3. `cd Discord` +4. Install Python 3.9+ (at least 3.11 is recommended) for your OS +5. `python3 -m pip install -r requirements.txt` +6. Run it with `python3 main.py` after configuring + +## Configuration + +So bot has its "config_example.json" and it needs to be changed. +Copy this file to "config.json" and open it with any text editor. +Modify the newly created configuration file to fit your needs. + +Mandatory keys to modify: + +- guild +- bot.owner +- bot.bot_token +- database.* +- categories.* +- channels.* +- roles.* + +After all of that you're good to go! Happy using :) \ No newline at end of file