Add documentation

jonahsnider · Aug 4, 2018 · 107eba5 · 107eba5
1 parent 76ed355
commit 107eba5
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,23 @@
+# music-downloader
+
+Command line utility to download music from YouTube
+
+## Installation
+
+### [NPM](https://www.npmjs.com/)
+
+```bash
+npm i
+```
+
+### [Yarn](https://yarnpkg.com/)
+
+```bash
+yarn
+```
+
+## Usage
+
+1. Edit `videos.txt` and put one YouTube video resolvable (youtube.com URL, youtu.be URL, or video ID.)
+2. Run `index.js`.
+3. Use audio files in the `audio` directory.