diff --git a/README.md b/README.md index 9fa6e69..c3f5c99 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,28 @@ -yandex-music-download +Yandex Music Downloader ===================== -Yandex Music downloader +This is a simple command line Perl script for downloading music from Yandex Music (http://music.yandex.ru). +Origin of the script is the following article: http://kaimi.ru/2013/11/yandex-music-downloader/ + +# Usage + +```bat +ya.pl [-adkpt] [long options...] + -p --playlist playlist id to download + -k --kind playlist kind (eg. ya-playlist, music-blog, + music-partners, etc.) + -a --album album to download + -t --track track to download (album id must be specified) + -d --dir download path (current direcotry will be used by + default) + + --debug print debug info during work + --help print usage + + Example: + ya.pl -p 123 -k ya-playlist + ya.pl -a 123 + ya.pl -a 123 -t 321 +``` + +For further assistance don't hesitate to ask for help in GitHub issues or on the blog: http://kaimi.ru