Merge branch 'master' of github.com:Zenrac/Watora

README.md

@@ -1,2 +1,31 @@
+<a href="https://www.patreon.com/bePatron?u=7139372"><img alt="Become a Watora's Patron" src="https://c5.patreon.com/external/logo/become_a_patron_button.png" height="35px"></a><br>
 # Watora
-Watora discord bot source
+Here's the official repository of Watora, the discord music bot. 
+
+## Requirements: <br>
+- [Python3+ with pip](https://www.python.org/downloads/)<br>
+- [mongodb](https://www.mongodb.com/download-center/community) <br>
+- [Java](https://www.java.com/fr/download/) <br>
+
+## Installation
+```
+git clone https://github.com/Zenrac/Watora
+cd Watora
+pip install -r requirements.txt
+```
+
+## Get Started
+Fill your credentials and tokens in config/tokens.json and settings.json, you can use the examples as a base.<br>
+First, start a mongo server in a terminal.
+```
+mongod
+```
+Start Watora with `run.bat` on Windows, or `run.sh` on Linux.<br>
+Make sure that you have a running a [Lavalink server](https://github.com/Frederikam/Lavalink) to use music features.<br>
+Also, you may have to delete the `cogs/web.py` cog has it will not be useful in any point for a local bot.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
+
+[![Discord Bots](https://discordbots.org/api/widget/220644154177355777.svg)](https://discordbots.org/bot/220644154177355777)