From dd09c159f649e6d425df7042113976737bd8a90d Mon Sep 17 00:00:00 2001 From: Nemo Date: Thu, 8 Jun 2017 01:56:45 +0530 Subject: [PATCH] Adds README --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ec93800 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# youtube-ripper + +Helps you download music compilations from youtube. +Will automatically download the video, split it into chunks, +and apply proper id3v2 tags on all the files (including cover-art) + +## Dependencies + +- _Asssumes_ that `youtube-dl` and `ffmpeg` are available in `$PATH` +- Takes care of everything else + +## Opinions + +This software has opinions: + +- You care about metadata and tagging your music properly +- All music must have cover art embedded +- You have `youtube-dl` and `ffmpeg` already installed +- I am smart enough to parse youtube descriptions + +## Installation + + npm install -g youtube-ripper + +## Usage + + youtube-ripper "https://www.youtube.com/watch?v=41Y6xov0ppw" + +## Configuration + +- Pass a cue file instead of using the youtube description +- `--album-art` Pass custom album art image (Uses the youtube thumbnail by default) +- `--album-artist` Pass a specific Album Artist. (Picks up the artist from the video by default) +- `--genre` Pass a specific genre to use. (Picks up from the video by default) + +## HACKING + +- If this video does not work on a specific video, please attach the debug log output +- Pull Requests are welcome that add support for a better parser without breaking the existing tests +- Please add tests for any new functionality + +## License + +Licensed under the [MIT License][mit] + +[mit]: https://nemo.mit-license.org/