diff --git a/README.md b/README.md index 5cf5f76..a68e8af 100644 --- a/README.md +++ b/README.md @@ -1 +1,49 @@ -# free-bandcamp-downloader \ No newline at end of file +# free-bandcamp-downloader + +Download free and $0 minimum albums and tracks from Bandcamp + +## Installation + +Requires Firefox and [geckodriver](https://github.com/mozilla/geckodriver/releases) + +Make sure geckodriver is in your PATH environment variable + +Install with pip +``` +py -m pip install git+https://github.com/7x11x13/free-bandcamp-downloader +``` + +## Usage + +```Usage: + bcdl-free (-a | -l )[--force][-d | --dir ][-e | --email ] + [-z | --zipcode ][-c | --country ][-f | --format ] + bcdl-free setdefault [-d | --dir ][-z | --zipcode ] + [-c | --country ][-f | --format ] + bcdl-free defaults + bcdl-free clear + bcdl-free (-h | --help) + bcdl-free --version +Options: + -h --help Show this screen + --version Show version + -a Download the album at URL + -l Download all free albums of the label at URL + --force Download even if album has been downloaded before + setdefault Set default options + defaults List the default options + clear Clear download history + -d --dir Set download directory + -c --country Set country + -z --zipcode Set zipcode + -e --email Set email + -f --format Set format +Formats: + - FLAC + - V0MP3 + - 320MP3 + - AAC + - Ogg + - ALAC + - WAV + - AIFF```