doc: update README.md and add lib in package

This commit is contained in:
HugoPoi 2020-09-27 11:37:58 +02:00
parent 4f7d770ed3
commit 086cf7eeb1
2 changed files with 10 additions and 0 deletions

View File

@ -17,6 +17,7 @@ Inspired by [DatMusic](https://github.com/alashow/datmusic-api), [MyFreeMp3](htt
*TODO*
* Dowload all songs in a folder
* Add Spotify metadatas in the m3u8 file
* Add proper command line options
* Rewrite this as a plugin for Ampache
* Rewrite this as a plugin for Funkwhale
@ -32,3 +33,11 @@ Inspired by [DatMusic](https://github.com/alashow/datmusic-api), [MyFreeMp3](htt
1. Install nodejs/npm
1. `npx vk-music-dl https://open.spotify.com/playlist/6LgeEhc97Azxq6sinJQt6w`
## Usage as library
```javascript
const {main} = require('vk-music-dl/lib');
main('https://open.spotify.com/playlist/6LgeEhc97Azxq6sinJQt6w');
```

View File

@ -21,6 +21,7 @@
"downloader"
],
"files": [
"lib",
"index.js",
"README.md"
],