update docs
This commit is contained in:
parent
4466fa6723
commit
95ceefd0fe
12
README.md
12
README.md
@ -12,7 +12,17 @@ pip install comicfn2dict
|
||||
|
||||
## API
|
||||
|
||||
look at `comicfn2dict/comicfn2dict.py`
|
||||
<!-- eslint-skip -->
|
||||
|
||||
```python
|
||||
from comicfn2dict import comicfn2dict, dict2comicfn
|
||||
|
||||
path = "Comic Series #001 Title (2024).cbz"
|
||||
|
||||
metadata: dict[str, str| tuple[str,...]] = comicfn2dict(path, verbose=0)
|
||||
|
||||
filename: str = dict2comicfn(metadata, bool=True, verbose=0)
|
||||
```
|
||||
|
||||
## CLI
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user