From 1cc99d02e185669b868c3cfc603ca6fcedef39f6 Mon Sep 17 00:00:00 2001 From: reality Date: Mon, 13 May 2013 18:21:50 +0000 Subject: [PATCH] ] --- modules/reddit/README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 modules/reddit/README.md diff --git a/modules/reddit/README.md b/modules/reddit/README.md new file mode 100644 index 0000000..aac11fc --- /dev/null +++ b/modules/reddit/README.md @@ -0,0 +1,29 @@ +## Reddit + +Various Reddit functionality + +### Description + +This module provides Reddit related functionality, which is currently limited to +reading various links, but will be expanded in future to include stuff like +monitoring posts and creating its own. + +### API + +#### getSubredditInfo(name, callback) +Get information about a subreddit from the Reddit API. Callback takes one +argument, the data returned from the API. + +#### getPostInfo(name, callback) +Get information about a post from the Reddit API. Callback takes one argument, +the data returned from the API about the post. + +#### getCommentInfo(post, name, callback) +Get information about a particular comment in a particular post. Callback takes +one argument, information about the given comment. + +### Hooks + +#### link +Posts a summary when either a subreddit, a post or a comment is linked in a +channel.