## Installation
### From PyPI
-`pip install lightcards`
+```
+pip install lightcards
+```
### From Git
+#### Stable version
+```
+pip install git+https://git.sr.ht/~armaan/lightcards
+```
+
+#### Development version
```
-git clone https://git.sr.ht/~armaan/lightcards
-cd lightcards
-git checkout $(git tag | tail -n 1) # Don't include to use development version
-`pip install .`
+pip install git+https://git.sr.ht/~armaan/lightcards@devel
```
## Usage
-see `lightcards --help`
+See `lightcards --help` for usage information.
## Input file
-See `contrib/example.md` for an example input file
+`contrib/example.md` is an example input file. Lightcards takes the first table from a valid Markdown or HTML file. Each row is a card, and the two columns are the front and back.
## License
Copyright Armaan Bhojwani 2021, MIT license