# lightcards
-Lightcards is a simple terminal program for creating flashcards from a markdown table
+Terminal flashcards from Markdown.
+
+## Installation
+### From PyPI
+```
+pip install lightcards
+```
+
+### From Git
+#### Stable version
+```
+pip install git+https://git.sr.ht/~armaan/lightcards
+```
+
+#### Development version
+```
+pip install git+https://git.sr.ht/~armaan/lightcards@devel
+```
+
+## Usage
+See `lightcards --help` for usage information.
+
+## 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