SpiffyTitles: Updates formatting for channel black/white list documentation
This commit is contained in:
parent
fe4c58699e
commit
bb6d7ae5ac
21
README.md
21
README.md
|
|
@ -44,23 +44,24 @@ titles will be shown in all channels. Default value: `""`
|
|||
`channelBlacklist` - a comma separated list of channels in which titles should never be displayed. If `""`,
|
||||
titles will be shown in all channels. Default value: `""`
|
||||
|
||||
About white/black lists
|
||||
|
||||
- If `channelWhitelist` and `channelBlacklist` are empty, then titles will be displayed in every channel
|
||||
- If `channelBlacklist` has #foo, then titles will be displayed in every channel except #foo
|
||||
- If `channelWhitelist` has #foo then `channelBlacklist` will be ignored
|
||||
### About white/black lists ###
|
||||
|
||||
Examples
|
||||
|
||||
Show titles in every channel except #foo
|
||||
- If `channelWhitelist` and `channelBlacklist` are empty, then titles will be displayed in every channel
|
||||
- If `channelBlacklist` has #foo, then titles will be displayed in every channel except #foo
|
||||
- If `channelWhitelist` has #foo then `channelBlacklist` will be ignored
|
||||
|
||||
### Examples ###
|
||||
|
||||
|
||||
### Show titles in every channel except #foo ###
|
||||
|
||||
!config supybot.plugins.SpiffyTitles.channelBlacklist #foo
|
||||
|
||||
Only show titles in #bar
|
||||
### Only show titles in #bar ###
|
||||
|
||||
!config supybot.plugins.SpiffyTitles.channelWhitelist #bar
|
||||
|
||||
Remove channel whitelist
|
||||
### Remove channel whitelist ###
|
||||
|
||||
!config supybot.plugins.SpiffyTitles.channelWhitelist ""
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue