falso
/
oddluck-limnoria-plugins
mirror of https://github.com/oddluck/limnoria-plugins.git
1
0
Fork 0
Code Issues Releases Wiki Activity

SpiffyTitles: updates README with notable features

This commit is contained in:
PrgmrBill 2015-04-19 16:56:03 -04:00
parent 329111c018
commit febfec0c1b
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,11 +1,18 @@
# SpiffyTitles #
Displays link titles when posted in a channel. This plugin has the following goals:
Displays link titles when posted in a channel.
- Extreme reliability and in the case of failure, robust error reporting to ease debugging. Errors
are logged.
## Notable features ##
- The ability to customize features that could conceivably need to change (within reason)
- Configurable template so you can decide how titles are displayed and what they say
- Additional information about [Youtube](https://youtube.com) videos
- Additional information about [imgur](https://imgur.com) links
- Rate limiting to mitigate abuse
- Configurable white/black list to control where titles are disabled
- Configurable list of user agents
- Ability to ignore domains using a regular expression
Check out the [available options](#available-options)
## Using SpiffyTitles ##
- Install the requirements: `pip install -r SpiffyTitles/requirements.txt --user --upgrade`