diff --git a/README.md b/README.md index 66127fc..c6ea0bd 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,24 @@ your disk. # Features -* [ ] Vacuum the entirety of a website recursively +* [x] Vacuum the entirety of a website recursively * [x] Use multithreading * [x] Write the website's content to your disk * [x] Offline navigation + +# Options + +|Option|Behavior| +|---|---| +|`-h|--help`|Displays help information| +|`-v|--verbose`|Activate Verbose output| +|`-d|--depth`|Specify the level of depth to go to when visiting the website| +|`-j|--jobs`|Number of threads to use| +|`-o|--output`|Output directory where the downloaded files are written| +|`-t|--tries`|Number of times to retry when the downloading of a page fails| + +# Example + +A common use case could be the following: + +`suckit http://books.toscrape.com -j 8 -o /path/to/downloaded/pages/