clean up README
This commit is contained in:
parent
bfdd600bf5
commit
a8b3e4f9b8
16
README.md
16
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"]
|
||||
)
|
||||
```
|
||||
|
Loading…
Reference in New Issue
Block a user