From e1bcb25c936fc874620971056dd2edf4004fd841 Mon Sep 17 00:00:00 2001
From: HugoPoi <hugo.poissonnet@gmail.com>
Date: Thu, 2 Jul 2020 00:53:35 +0200
Subject: [PATCH] doc: add README

---
 .env.example |  1 +
 README.md    | 42 ++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 43 insertions(+)
 create mode 100644 .env.example
 create mode 100644 README.md

diff --git a/.env.example b/.env.example
new file mode 100644
index 0000000..4acea83
--- /dev/null
+++ b/.env.example
@@ -0,0 +1 @@
+ACCESS_TOKEN="A token for VKontact Music"
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8418c9a
--- /dev/null
+++ b/README.md
@@ -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