add example usage to readme

2022-01-17 22:07:55 +01:00
parent 0dde5ee24e
commit 17dd2f665e
1 changed files with 20 additions and 1 deletions
--- a/README.md
+++ b/README.md
@@ -1 +1,20 @@
-TODO
+# Usage
+
+```python
+from manga_ocr import MangaOcr
+
+mocr = MangaOcr()
+text = mocr('/path/to/img')
+```
+
+or
+
+```python
+import PIL.Image
+
+from manga_ocr import MangaOcr
+
+mocr = MangaOcr()
+img = PIL.Image.open('/path/to/img')
+text = mocr(img)
+```