From 7a5da4ad268f2510656bd5d16d837e9bbc4dbd16 Mon Sep 17 00:00:00 2001 From: Dylan Greene Date: Wed, 27 Apr 2016 15:12:06 -0400 Subject: [PATCH] update readme --- readme.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 37e3b0e..3741fb3 100644 --- a/readme.md +++ b/readme.md @@ -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