From febfec0c1b022de08b2b7333759e280e2bb7460f Mon Sep 17 00:00:00 2001 From: PrgmrBill Date: Sun, 19 Apr 2015 16:56:03 -0400 Subject: [PATCH] SpiffyTitles: updates README with notable features --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cf213b8..f5c4358 100644 --- a/README.md +++ b/README.md @@ -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`