clean up README

This commit is contained in:
cellarspoon 2021-11-29 17:29:05 +01:00
parent bfdd600bf5
commit a8b3e4f9b8
No known key found for this signature in database
GPG Key ID: 03789458B3D0C410

View File

@ -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"]
)
```