From f4f34d285235d6e39723f9da5841f48fbacab1da Mon Sep 17 00:00:00 2001 From: reality Date: Fri, 17 May 2013 11:28:04 +0000 Subject: [PATCH] documentation for imgur [#352] --- modules/imgur/README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 modules/imgur/README.md diff --git a/modules/imgur/README.md b/modules/imgur/README.md new file mode 100644 index 0000000..7e08b5d --- /dev/null +++ b/modules/imgur/README.md @@ -0,0 +1,34 @@ +## imgur + +Various imgur functionality. + +### Description + +Posts information on imgur links which are pasted into the channel and provides +functionality to generate a random imgur link. + +### Commands + +#### ~ri +Generate a random imgur image and post a link to it in the channel. + +### API + +#### getRandomImage(callback) +Generate a random imgur image by generating random slugs and then testing for +their existence until it finds one which exists (and hasn't been deleted). +Callback is given with two parameters, the URL of the generated image, and the +slug for the generated image. + +#### getImageInfoString(slug, callback) +Return a string containing info about the image with the given slug from the +imgur API. Callback is called with one argument, the info string. + +#### getImageInfo(slug, callback) +Return data from the imgur API on an image with the given slug. Callback is +called with one argument, the information returned by the API. + +### Hooks + +#### link +Posts information about an imgur link when one is linked in the channel.