diff --git a/README.md b/README.md index 37d6d03..263cb3c 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,61 @@ A simple scraper to filter and download images from kemono.party ## Downloader Released Source code is in `./main` +## Usage + +### Download Option +`--link []` +download link, should be same site, separate by comma +`--creator [:]` +download creators, separate by comma +`--banner bool` + +### Post Filter Option +`--first int` +download first n post +`--last int` +download last n post +`--date YYYYMMDD` +download post on date +`--date-before YYYYMMDD` +download post before date +`--date-after YYYYMMDD` +download post after date +`--update YYYYMMDD` +download post updated on date +`--update-before YYYYMMDD` +download post updated before date +`--update-after YYYYMMDD` + +### Image Filter Option +download post updated after date +`--extensionOnly []` +download post with extension, separate by comma +`--extensionExcept []` +download post without extension, separate by comma + +### Downloader Option +`--output PATH` +output path +`--overwrite bool` +overwrite existing file +`--async bool` +download posts asynchronously, may cause the file order is not the same as the post order, can be used with --with-prefix-number, default false +`--max-download-parallel int` +max download file concurrent, default is 3, async mode only +`--with-prefix-number bool` +add prefix number to file name `-`, default false +`--name-rule-only-index bool` +only use index as file name, default false +`--download-timeout int` +download timeout in seconds, default 300 +`--retry int` +retry times, default 3 +`--retry-interval int` +retry interval in seconds, default 10 +`--rate-limit int` +rate limit in request/s, default 2 + ## Features With Kemono-scraper, you can implement a Downloader to take advantage of features such as multi-connection downloading, resume broken downloads, and more.