From 95ceefd0fea2184ff3b48664ee7a517a7f84b04e Mon Sep 17 00:00:00 2001
From: AJ Slater <aj@slater.net>
Date: Fri, 23 Feb 2024 18:23:08 -0800
Subject: [PATCH] update docs

---
 README.md | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 57b5f90..d88bdef 100644
--- a/README.md
+++ b/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