From 9b5331a82abc1a33f632664632bfadffe09be7eb Mon Sep 17 00:00:00 2001 From: PrgmrBill Date: Sun, 19 Apr 2015 23:00:53 -0400 Subject: [PATCH] SpiffyTitles: updates documentation for handlers, imgur specifically --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f3c3cd1..3c6e161 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,8 @@ Example output: ^ Google.com +### Youtube handler ### + `youtubeTitleTemplate` - This is the template used when showing the title of a YouTube video Default value: `^ {{title}} :: Duration: {{duration}} :: Views: {{view_count}} :: Rating: {{rating}}` @@ -46,6 +48,8 @@ Example output: ^ Snoop Dogg - Pump Pump feat. Lil Malik :: Duration: 00:04:41 :: Views: 189,120 :: Rating: 4.82 +### Youtube handler ### + `imgurTemplate` - This is the template used when showing information about an [imgur](https://imgur.com) link. Default value @@ -66,10 +70,18 @@ Example output: ^ [compsci] Regex Fractals :: 33 images :: 21,453 views :: safe for work -Notes on the imgur handler: +### Using the imgur handler ### -- You'll need a [register an application with imgur](https://api.imgur.com/oauth2/addclient) +- You'll need to [register an application with imgur](https://api.imgur.com/oauth2/addclient) - Select "OAuth 2 authorization without a callback URL" +- Once registered, set your client id and client secret and reload SpiffyTitles: + + !config set supybot.plugins.SpiffyTitles.imgurClientID + !config set supybot.plugins.SpiffyTitles.imgurClientSecret + !reload SpiffyTitles + +### Notes on the imgur handler ### + - If there is a problem reaching the API the default handler will be used as a fallback. See logs for details. - The API seems to report information on the originally uploaded image and not other formats - If you see something from [the imgur api](https://api.imgur.com/models/image) that you want and is not available @@ -94,7 +106,6 @@ titles will be shown in all channels. Default value: `""` ### Examples ### - ### Show titles in every channel except #foo ### !config supybot.plugins.SpiffyTitles.channelBlacklist #foo