diff --git a/README.md b/README.md index 0073b7f..78fc782 100755 --- a/README.md +++ b/README.md @@ -2,12 +2,12 @@ A simple spigot plugin which allows whitelisting through a discord text channel. This provides an easy way for users to whitelist without needing to be on the minecraft server. -##### Features: +### Features: - 3 separate role groups: - - add-remove group: allows the user to add and remove users from the whitelist an unlimited amount of times (recommended for owners and admins) - - add group: allows the user to add to the whitelist an unlimited amount of times (recommended for moderators) - - limited-add group: allows the user to whitelist a limited amount of times (recommended for users, default amount is 3) + - **add-remove group**: allows the user to add and remove users from the whitelist an unlimited amount of times (recommended for owners and admins) + - **add group**: allows the user to add to the whitelist an unlimited amount of times (recommended for moderators) + - **limited-add group**: allows the user to whitelist a limited amount of times (recommended for users, default amount is 3) - limited-add group can be disabled in the config (enabled by default) - removed list: @@ -22,7 +22,7 @@ A simple spigot plugin which allows whitelisting through a discord text channel. - bot only listens for messages in select text channels - logs whitelist attempts from valid roles in the console -##### Set Up: +### Set Up: Config file is located at: (server-root)/plugins/DiscordWhitelister - this needs a valid bot token and valid channel ids to work. To create a Discord application and/or find your discord bot token, follow this link: https://discordapp.com/developers/applications/