diff --git a/README.md b/README.md index 637c8e0..ac347b8 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,22 @@ # temp-index -## hacking +[![PyPI version](https://badge.fury.io/py/temp-index.svg)](https://badge.fury.io/py/temp-index) + +## install it + +```bash +pip install temp-index +``` + +## use it ```python from temp_index import make_cards -make_cards("mycards.pdf", "sqlite:///metadata.db", ["title", "uploaded_at", "comments", "authors", "tags"]) +make_cards( + "catalogue.pdf", + "sqlite:///metadata.db", + ["title", "uploaded_at", "comments", "authors", "tags"] +) ```