Blade2021 / Sherlock

Discord Administration BoT
GNU General Public License v3.0
6 stars 4 forks source link

[Bug] Documentation needs updating #20

Open SirGoodenough opened 2 years ago

SirGoodenough commented 2 years ago

Describe the bug Typo in the docs / line no longer applies

In the command list, section as such:

Moderator Role Assignment

Sherlock supports customizable mod roles. This allows you to designate what roles will have access to any assortment of commands as you wish. This is made possible using the binary system.

Mute - 1 (Both mute and unmute)
Infraction System - 2 (Submit infractions and get infraction list)
Channel Cooldown - 4 (Place a channel on cooldown)
Archive/Retrieve Channel - 8 (Push a channel to the designated archive category)
Auto Roles - 32 (Set a role that is given to a user when they first join)

To give a mod access to mute and cooldown but not infractions, you would set your value to 5.
To give them only access to mute, you would set your value to 1.
To set your permissions to all, you would set it to 7.

You are simply going to take the sum of all permissions you want to give to a role.

should remove the line

To set your permissions to all, you would set it to 7.

as it no longer applies...