diff --git a/README.md b/README.md index b77f12c..03d77c4 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ +Become a Watora's Patron
# Watora -Watora discord bot source +Here's the official repository of Watora, the discord music bot. + +## Requirements:
+- [Python3+ with pip](https://www.python.org/downloads/)
+- [mongodb](https://www.mongodb.com/download-center/community)
+- [Java](https://www.java.com/fr/download/)
+ +## 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.
+First, start a mongo server in a terminal. +``` +mongod +``` +Start Watora with `run.bat` on Windows, or `run.sh` on Linux.
+Make sure that you have a running a [Lavalink server](https://github.com/Frederikam/Lavalink) to use music features.
+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)