Add sections to Readme

This commit is contained in:
hartator 2015-08-10 01:02:43 -05:00
parent 61f42f6fd7
commit 594b71780a

View File

@ -10,11 +10,13 @@ You need to install Ruby on your system - if you don't already have it, then run
## Usage ## Usage
### Basic
Pass the base url of the website you want to retrieve as an argument (e.g., http://example.com): Pass the base url of the website you want to retrieve as an argument (e.g., http://example.com):
wayback_machine_downloader 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. URLs and links structure are preserved as much as possible. 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. URLs and links structure are preserved as much as possible.
@ -24,7 +26,7 @@ You may want to supply a specific timestamp to lock your backup to an older vers
wayback_machine_downloader http://example.com` --timestamp 20060716231334 wayback_machine_downloader http://example.com` --timestamp 20060716231334
## Contributing ### Contributing
Contributions are welcome! Just submit a pull request via GitHub. Contributions are welcome! Just submit a pull request via GitHub.