diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..6e5f35d --- /dev/null +++ b/readme.md @@ -0,0 +1,19 @@ +# Rolebot + +Rolebot is a minimal discord bot that allows server members to manage their own roles. +You might want to use this for general, non-permission-granting roles that anyone should +be able to freely assign themselves like +- pronouns +- players of a particular game +- favorite biscuit + +## Use +- [Create a Discord application](https://discord.com/developers/applications) +- Copy the bot token, and make it available under the env var `DISCORD_TOKEN` +- Go to oauth -> URL generator + - Tick bot, then "manage roles" in the bot permissions. +- Copy the URL into the menu bar and authorise the bot to join your server +- This will automatically make a role with the same name as the bot. **Rolebot will + allow users to add or remove themselves from any role lower than this one in the + order**. Please make sure no permission-giving roles are lower than it! +- Run the bot. That's it!