fix readme

NEWS.md

@@ -1,5 +1,9 @@
 # 📰 comicfn2dict News
 
+## v0.1.3
+
+- Fix README
+
 ## v0.1.2
 
 - Add GN to format types.

README.md

@@ -1,5 +1,24 @@
-# ajs boilerplate
+# comicfn2dict
 
-Scripts for developing python apps with javascript frontends.
+An API and CLI for extracting structured comic metadata from filenames.
 
-Run scripts with make. Run make without a target for documentation.
+## Install
+
+```sh
+pip install comicfn2dict
+```
+
+## API
+
+look at `comicfn2dict/comicfn2dict.py`
+
+## CLI
+
+```sh
+comicfn2dict "Series Name #01 - Title (2023).cbz"
+{'ext': 'cbz',
+'issue': '001',
+'series': 'Series Name',
+'title': 'Title',
+'year': '2023'}
+```

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "comicfn2dict"
-version = "0.1.2"
+version = "0.1.3"
 description = "Parse common comic filenames and return a dict of metadata attributes. Includes a cli."
 license = "GPL-3.0-only"
 authors = ["AJ Slater <aj@slater.net>"]