diff --git a/README.md b/README.md index bcccea6..19aa628 100644 --- a/README.md +++ b/README.md @@ -23,19 +23,30 @@ It will download the last version of every file present on Wayback Machine to `. ## Advanced Usage - Usage: wayback_machine_downloader http://example.com + Usage: wayback_machine_downloader http://example.com + + Download an entire website from the Wayback Machine. + + Optional options: + -d, --directory PATH Directory to save the downloaded files to. Default is ./websites/ plus the domain name. + -f, --from TIMESTAMP Only files on or after timestamp supplied (ie. 20060716231334) + -t, --to TIMESTAMP Only files on or before timestamp supplied (ie. 20100916231334) + -o, --only ONLY_FILTER Restrict downloading to urls that match this filter (use // notation for the filter to be treated as a regex) + -x, --exclude EXCLUDE_FILTER Skip downloading of urls that match this filter (use // notation for the filter to be treated as a regex) + -a, --all Expand downloading to error files (40x and 50x) and redirections (30x) + -c, --concurrency NUMBER Number of multiple files to dowload at a time. Default is one file at a time. (ie. 20) + -l, --list Only list file urls in a JSON format with the archived timestamps. Won't download anything. + -v, --version Display version + +## Specify directory to save files to - Download an entire website from the Wayback Machine. + -d, --directory PATH - Optional options: - -f, --from TIMESTAMP Only files on or after timestamp supplied (ie. 20060716231334) - -t, --to TIMESTAMP Only files on or before timestamp supplied (ie. 20100916231334) - -o, --only ONLY_FILTER Restrict downloading to urls that match this filter (use // notation for the filter to be treated as a regex) - -x, --exclude EXCLUDE_FILTER Skip downloading of urls that match this filter (use // notation for the filter to be treated as a regex) - -a, --all Expand downloading to error files (40x and 50x) and redirections (30x) - -l, --list Only list file urls in a JSON format with the archived timestamps. Won't download anything. - -c, --concurrency NUMBER Number of multiple files to download at a time. Default is one file at a time. (ie. 20) - -v, --version Display version +Optional. By default, Wayback Machine Downloader will download files to `./websites/` followed by the domain name of the website. You may want to save files in a specific directory using this option. + +Example: + + wayback_machine_downloader http://example.com --directory downloaded-backup/ ## From Timestamp