scraping/skallwar.suckit
1
0
Fork 0
mirror of https://github.com/Skallwar/suckit.git synced 2026-09-10 07:16:19 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

readme: Add options and example

Browse source
This commit is contained in:
cohenarthur 2020-04-29 20:25:06 +02:00
parent de68eae98d
commit be1b6f07a6
1 changed files with 18 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -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/