RabbitLabs/random-bunny
5
0
Fork 0
Code Issues 11 Pull requests 11 Projects 1 Releases 18 Wiki Activity Actions

update readme

Browse source
This commit is contained in:
Dylan Greene 2016-04-27 15:12:06 -04:00
parent 7b8a0009ed
commit 7a5da4ad26
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
readme.md
View file

@ -29,11 +29,17 @@ randomPuppy()
### randomPuppy()
Returns a random puppy image from http://imgur.com/ from https://www.reddit.com/r/puppy
Returns a `promise` for a random puppy image url from http://imgur.com/ from https://www.reddit.com/r/puppy
### randomPuppy(subreddit)
Returns a random image from the selected subreddit. Warning: We cannot promise it will be a puppy.
Returns a `promise` for a random image url from the selected subreddit. *Warning: We cannot promise it will be a image of a puppy!*
## Notes
* Node 4 or newer.
* Caches results from imgur in memory.
* Created for the purpose of using in a training exercise on different ways to do async in JavaScript at [Opower](https://opower.com/).
## License