diff --git a/README.md b/README.md new file mode 100644 index 0000000..4c6b37c --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Mastermind Bot + +Mastermind Bot is a Discord bot made to reveal class leaderboard, though a [mastermind game]() (but you can adapt it for other kind of leaderboards). + +## Installation + +1. Clone the repository (`git clone https://git.arkitu.fr/arkitu/mastermind-bot`) +2. Install the [Go toolchain](https://go.dev/dl/) +3. Complete the `_settings.json` file, then rename it to `settings.json` +4. Run the bot with `go run .` + +## Contact + +If you have any questions, feature requests or if you want to contribute to the project, please contact me (however you can, because there are a lot of bots on this instance so I have deactivated some features for users who are not logged in)