Skip to content

Commit

Permalink
add config file description
Browse files Browse the repository at this point in the history
  • Loading branch information
elvis972602 committed Feb 5, 2023
1 parent cc8c997 commit e55b9fb
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@ A simple scraper to filter and download images from kemono.party
## Downloader Released
Source code is in `./main`

## Usage
## Flag Option

### Download Option
`--link [<urls>]`
download link, should be same site, separate by comma
`--creator [<service>:<id>]`
download creators, separate by comma
`--banner bool`
download banner, default is false

### Post Filter Option
`--first int`
Expand All @@ -29,9 +30,9 @@ download post updated on date
`--update-before YYYYMMDD`
download post updated before date
`--update-after YYYYMMDD`
download post updated after date

### Image Filter Option
download post updated after date
`--extensionOnly [<ext>]`
download post with extension, separate by comma
`--extensionExcept [<ext>]`
Expand Down Expand Up @@ -59,6 +60,17 @@ retry interval in seconds, default 10
`--rate-limit int`
rate limit in request/s, default 2

## Config File
config file is in `./config.yaml`
Option in config is same as flag option, but without `--` prefix, and will be overridden by flag option .Can set the not often changed option in config file, and use flag option to override it
Example:
```yaml
banner: true
async: true
max-download-parallel: 5
with-prefix-number: true
```
## Features
With Kemono-scraper, you can implement a Downloader to take advantage of features such as multi-connection downloading, resume broken downloads, and more.

0 comments on commit e55b9fb

Please sign in to comment.