Clarify Sudo usage in Readme #15

This commit is contained in:
hartator 2015-11-03 14:01:07 -06:00
parent 685c3acb46
commit fefea48e30

View File

@ -5,30 +5,30 @@ 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.
Then run (you may need sudo):
Then run:
gem install wayback_machine_downloader
## Usage
Tip: If you have permission errors, you might have to run `sudo gem install wayback_machine_downloader`.
### Basic
## Basic Usage
Run wayback_machine_downloader with the base url of the website you want to retrieve as a parameter (e.g., http://example.com):
wayback_machine_downloader http://example.com
### How it works
## How it works
It will download the last version of every file present on Wayback Machine to `websites/example.com/`. It will also re-create a directory structure and auto-create `index.html` pages to work seamlessly with Apache and Nginx. All files downloaded are the original ones and not Wayback Machine rewritten versions. This way, URLs and links structure are the same than before.
### Optional Timestamp
## 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 using the Wayback link: 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
### Contributing
## Contributing
Contributions are welcome! Just submit a pull request via GitHub.