reddit-simple-client - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

package.json

 {
   "name": "reddit-simple-client",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Simple module for interacting with Reddit, using an unauthenticated client",
@@ -5,0 +5,0 @@ "main": "src/RedditClient.js",

README.md

@@ -20,2 +20,27 @@ reddit-client
 const latestRedditComments = await RedditClient.getLatestCommentsFromReddit(100);
-```
+```
+
+Documentation ⭐
+---------------
+### `ReddClient.getPostsFromSubreddit(numberOfPosts, subreddit, sortType)`  
+Gets a list of post objects  
+numberOfPosts - number of posts to retrieve, between 1-100  
+subreddit - subreddit to get posts from  
+sortType - E.G 'new', or 'hot'  
+return - Promise containing a list of RedditPost objects  
+
+### `ReddClient.getSubredditModList(subreddit)`  
+Gets the list of modderators for the subreddit  
+subreddit - subreddit to get moderators of
+return - Promise containing list of moderator usernames
+
+### `ReddClient.getLatestCommentsFromReddit(numberOfComments)`  
+Get a list of the newest comments from Reddit  
+numberOfComments A number between 10-100 (between 1-9 does not work for Reddit)  
+return - Promise containing list of comment objects
+
+### `RedditClient.MAX_NUM_POSTS`  
+Max number of posts or comments Reddit allows you to rerieve at once. If a number thats higher is passed, this number is used anyway  
+
+
+

No alert changes

Improved metrics

Total package byte prevSize

8081

increased by13.88%

Number of lines in readme file

46

increased by130%

No dependency changes