Skip to content

Commit

Permalink
Add information about blacklist/whitelist
Browse files Browse the repository at this point in the history
  • Loading branch information
PhantomShift committed Aug 16, 2024
1 parent 600ecc9 commit cf773f3
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,35 @@ to turn your backup into a zip file that Kotatsu can parse. Get this zip file on

If you don't plan on using the tool again any time soon, make sure to run `nekotatsu clear` to remove any files nekotatsu downloaded/generated from `nekotatsu update`.

## Whitelisting/Blacklisting

You may choose to filter which manga get converted with either a blacklist or a whitelist.
To make use of this, create a toml file, i.e. `nekotatsu.toml`, and populate it with an entry
named `whitelist` or `blacklist` which contains an array of source names, source URLs or source IDs.

```toml
# Example: only convert manga in your backup that came from mangadex
whitelist = [
"mangadex"
]
```

```toml
# Example: convert all manga in your backup except for ones from this ID and URL.
blacklist = [
2499283573021220255, # MangaDex's ID
"www.webtoons.com"
]
```

You can then use this config by adding the `--config <FILE>` option, for example,

```bash
nekotatsu convert my_backup.tachibk --config nekotatsu.toml
```

## CLI Help

Run the commands with `--help` to view these messages.

```
Expand Down

0 comments on commit cf773f3

Please sign in to comment.