Skip to content

Commit 99d7745

Browse files
committed
Update API docs
1 parent 0e03870 commit 99d7745

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,17 @@ $ npm install --save muse-json-generator
1313
```
1414

1515
## Usage
16+
Create a new file named `playlist.js`
17+
1618
```js
1719
const generator = require('muse-json-generator');
18-
console.log(generator(477331181, 480097777));
20+
generator(477331181, 480097777).then(playlist => {
21+
console.log(playlist);
22+
});
1923
```
2024

2125
```bash
22-
node xxx.js > playlist.json
26+
node playlist.js > playlist.json
2327
```
2428

2529
## API
@@ -29,7 +33,7 @@ const generator = require('muse-json-generator');
2933
```
3034
### generator(id, [id], [id], ...)
3135

32-
**Returns a JSON string.**
36+
**Returns Promise.**
3337

3438

3539
## License

0 commit comments

Comments
 (0)