doc: add README
This commit is contained in:
parent
30512b6f72
commit
e1bcb25c93
1
.env.example
Normal file
1
.env.example
Normal file
|
@ -0,0 +1 @@
|
||||||
|
ACCESS_TOKEN="A token for VKontact Music"
|
42
README.md
Normal file
42
README.md
Normal file
|
@ -0,0 +1,42 @@
|
||||||
|
# VK Music Downloader
|
||||||
|
|
||||||
|
A very simple tool to download music through VKontakte Music API.
|
||||||
|
|
||||||
|
This a proof of concept.
|
||||||
|
|
||||||
|
Inspired by [DatMusic](https://github.com/alashow/datmusic-api), [MyFreeMp3](https://myfreemp3cc.com/)
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
*For now*
|
||||||
|
|
||||||
|
* Parse a Spotify Playlist page
|
||||||
|
* Download a title from the playlist
|
||||||
|
|
||||||
|
*TODO*
|
||||||
|
|
||||||
|
* Download the html spotify page
|
||||||
|
* Dowload all songs in a folder
|
||||||
|
* Add proper command line options
|
||||||
|
* Document how to get a VK access token (need php and other things this
|
||||||
|
is very annoying)
|
||||||
|
* Publish on NPM
|
||||||
|
* Add proper cli support
|
||||||
|
* Rewrite this as a plugin for Ampache
|
||||||
|
* Rewrite this as a plugin for Funkwhale
|
||||||
|
|
||||||
|
## Goals
|
||||||
|
|
||||||
|
* Try to use state of art NodeJS APIs
|
||||||
|
* Demonstrate what we can do with 100 lines of Javascript (and an
|
||||||
|
infinity of dependencies, HALF OF THE WORLD LITERALY)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
BEWARE WIP
|
||||||
|
|
||||||
|
1. `git clone THIS`
|
||||||
|
1. `npm install`
|
||||||
|
1. Fill the `.env` with a `ACCESS_TOKEN=` for VK [HowTo](https://github.com/vodka2/vk-audio-token)
|
||||||
|
1. `curl https://open.spotify.com/playlist/6LgeEhc97Azxq6sinJQt6w > test.html`
|
||||||
|
1. `node . 0` => Download the first title of the playlist
|
Loading…
Reference in New Issue
Block a user