# lightcards
-Lightcards is a terminal program for using flashcards from a Markdown or HTML table. Currently under development.
+Terminal flashcards from Markdown.
-# Installation
+## Installation
+### From PyPI
+`pip install lightcards`
+
+### From Git
+```
+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 .`
+```
+
+## Usage
+see `lightcards --help`
+
+## Input file
+See `contrib/example.md` for an example input file
## License
Copyright Armaan Bhojwani 2021, MIT license