diff --git a/plugins/AutoMode/README.md b/plugins/AutoMode/README.md index 23577ec2e..d5380b950 100644 --- a/plugins/AutoMode/README.md +++ b/plugins/AutoMode/README.md @@ -1,3 +1,15 @@ -This plugin automaticly voices/halfops/ops users with #channel, capability -when they join to the channel. -It will also ban automaticly everyone who is in channel ban list ( @channel ban list ). +This plugin sets channel modes on users when they join the channel +depending on the configuration. + +If +* `plugins.automode.op` is set to `True`, users with the `#channel,op` +capability are opped when they join. +* `plugins.automode.halfop` is set to `True`, users with the +`#channel,halfop` are halfopped when they join. +* `plugins.automode.voice` is set to `True`, users with the +`#channel,voice` are voiced when they join. + +This plugin also kbans people on `@channel ban list` +(`config plugins.automode.ban`) when they join and if moding users with +lower capability is enabled, that is also applied to users with higher +capability (`config plugins.automode.fallthrough).