Georg/dbot
1
0
Fork 0
forked from GitHub/dbot
Code Issues Pull Requests Projects Releases Wiki Activity

Fixed crypto readme

Browse Source
This commit is contained in:
amki 2013-12-26 06:52:06 +00:00
parent 7a51fdf524
commit 4b4f0a1608
1 changed files with 12 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
modules/crypto/README.md
View File

@ -1,29 +1,21 @@
## Reddit ## Crypto
Various Reddit functionality Cryptography!
### Description ### Description
This module calculates different hashes or ciphertexts for some algorithms.
This module provides Reddit related functionality, which is currently limited to ### Commands
reading various links, but will be expanded in future to include stuff like
monitoring posts and creating its own.
### API #### ~md5 [text]
Calculate the MD5 hash of the given text.
#### getSubredditInfo(name, callback) #### ~sha1 [text]
Get information about a subreddit from the Reddit API. Callback takes one Calculate the SHA1 hash of the given text.
argument, the data returned from the API.
#### getPostInfo(name, callback) #### ~sha256 [text]
Get information about a post from the Reddit API. Callback takes one argument, Calculate the SHA256 hash of the given text.
the data returned from the API about the post.
#### getCommentInfo(post, name, callback) #### ~aes "[text]" "[key]"
Get information about a particular comment in a particular post. Callback takes Calculates the hash of the given text.
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.