diff --git a/README.md b/README.md index f581d92..dfe11ac 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ # free-bandcamp-downloader -Download free and $0 minimum name-your-price albums and tracks from Bandcamp (including ones that are sent to email), +Download free and $0 minimum name-your-price albums and tracks from Bandcamp (including ones that are sent to email), and tag them with data from the Bandcamp page. Also able to download items in your collection, if login cookies are supplied using the `--cookies` or `--identity` argument. ## Installation Install with pip + ``` pip install free-bandcamp-downloader ``` @@ -21,33 +22,40 @@ argument which you must supply the value of your "identity" cookie. ``` Usage: - bcdl-free (-a | -l )[--force][--no-unzip][-d | --dir ][-e | --email ] - [-z | --zipcode ][-c | --country ][-f | --format ] - [--cookies ][--identity ][--debug] - bcdl-free setdefault [-d | --dir ][-e | --email ][-z | --zipcode ] - [-c | --country ][-f | --format ] + bcdl-free setdefault [-d ] [-e ] [-z ] + [-c ] [-f ] bcdl-free defaults bcdl-free clear - bcdl-free (-h | --help) - bcdl-free --version + bcdl-free -h | --help | --version + bcdl-free [--debug] [--force] [--no-unzip] [-al] + [-d ] [-e ] [-z ] [-c ] [-f ] + [--cookies ] [--identity ] [--download-history-file ] + URL... + +Arguments: + URL URL to download. Can be a link to a label or release page + +Subcommands: + setdefaults set default configuration options + defaults list default configuration options + clear clear default configuration options + 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 - --no-unzip Don't unzip downloaded albums - 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 (set to 'auto' to automatically download from a disposable email) - -f --format Set format - --cookies Path to cookies.txt file so albums in your collection can be downloaded - --identity Value of identity cookie so albums in your collection can be downloaded - --debug Set loglevel to debug + -h --help Show this screen + --version Show version + --force Download even if album has been downloaded before + --no-unzip Don't unzip downloaded albums + --debug Set loglevel to debug + -a -l Dummy options, for backwards compatibility + -d --dir Set download directory + -c --country Set country + -z --zipcode Set zipcode + -e --email Set email (set to 'auto' to automatically download from a disposable email) + -f --format Set format + --cookies Path to cookies.txt file so albums in your collection can be downloaded + --identity Value of identity cookie so albums in your collection can be downloaded + --download-history-file Path to history file containing downloaded albums + Formats: - FLAC - V0MP3