Adjust documentation

This commit is contained in:
Ethan Lane 2021-04-03 19:59:27 +01:00
parent 58f4e629d8
commit 6ae96eb38d

View file

@ -12,13 +12,20 @@ $ npm install --save random-bunny
## Usage
```js
const randomBunny = require('random-bunny');
const { randomBunny } = require('random-bunny');
randomBunny('rabbits', 'new', res => {
console.log(res.title + ": " + res.url);
});
```
```js
const { promise } = require('random-bunny');
promise('rabbits', 'new').then((res) => {
console.log(res.title);
});
```
## API
@ -37,6 +44,12 @@ The json string which gets returned consists of:
- ups
- url
### `promise()`
Returns a `json string` for a random post in a `promise`. Accepts 2 arguments: `subreddit`, `sortby` ('new', 'hot', 'top').
The json string returned in the promise consists of the same above.
## Notes
* Node 4 or newer.