Updates SpiffyTitles README to be more clear/consistent

This commit is contained in:
PrgmrBill 2015-04-10 23:30:59 -04:00
parent e919e71def
commit f0d2a7bfea
1 changed files with 13 additions and 5 deletions

View File

@ -8,8 +8,16 @@ are logged.
- The ability to customize features that could conceivably need to change (within reason)
## Using SpiffyTitles ##
- You should disable the Web plugin and any other plugins that show link titles for best results
- You should `unload` the Web plugin and any other plugins that show link titles for best results
To unload the Web plugin:
!unload Web
Load SpiffyTitles:
!load SpiffyTitles
## Available Options ##
`defaultTitleTemplate` - This is the template used when showing the title of a link.
@ -28,13 +36,13 @@ Example output:
^ Snoop Dogg - Pump Pump feat. Lil Malik :: Views: 188,681 :: Rating: 4.82
`useBold` - Whether to bold the title. Defaults to `False`
`useBold` - Whether to bold the title. Default value: `False`
`channelWhitelist` - a comma separated list of channels in which titles should be displayed. If empty,
titles will be shown in all channels.
`channelWhitelist` - a comma separated list of channels in which titles should be displayed. If `False`,
titles will be shown in all channels. Default value: `[]`
`ignoredDomainPatterns` - a comma separated list of strings that are regular expressions to match
against URLs posted in channels.
against URLs posted in channels. Default value: `[]`
Examples