From fb4b5a9bd3a5862964c320692fa86c55d31501a5 Mon Sep 17 00:00:00 2001 From: hartator Date: Tue, 17 Nov 2015 14:52:22 -0600 Subject: [PATCH] Explain how the only flag works --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8b98dba..fa41438 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ -# Wayback Machine Downloader +# Wayback Machine Downloader Download any website from the Internet Archive Wayback Machine. ## Installation -You need to install Ruby on your system (>= 1.9.2) - if you don't already have it. +You need to install Ruby on your system (>= 1.9.2) - if you don't already have it. Then run: gem install wayback_machine_downloader - + **Tip:** If you run into permission errors, you might have to add `sudo` in front of this command. ## Basic Usage @@ -23,11 +23,17 @@ It will download the last version of every file present on Wayback Machine to `w ## Optional Timestamp -You may want to supply a specific timestamp to lock your backup to an older version of the website, which can be found inside the urls of the regular Wayback Machine website (e.g., http://web.archive.org/web/20060716231334/http://example.com). +You may want to supply a specific timestamp to lock your backup to an older version of the website, which can be found inside the urls of the regular Wayback Machine website (e.g., http://web.archive.org/web/20060716231334/http://example.com). Wayback Machine Downloader will then fetch only file versions on or prior to the timestamp specified: wayback_machine_downloader http://example.com --timestamp 20060716231334 +## Optional Only URL Filter + +You may want to retrieve files that are of certain type (e.g., .pdf, .jpg, .wrd...) or are in a specific directory. To do so, you can supply the `--only` flag with a string or a Regex to limit what Wayback Machine Downloader will download. + + wayback_machine_downloader http://example.com --only \.pdf + ## Contributing Contributions are welcome! Just submit a pull request via GitHub.