# lightcards
-Lightcards is a terminal program for using flashcards from a Markdown or HTML table. Currently under development.
+Terminal flashcards from Markdown.
-# Installation
-`pip install .`
+## 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) # Dont include to use development version
+pip install .
+```
+
+## Usage
+See `lightcards --help` for usage information.
+
+## Input file
+`contrib/example.md` is an example input file. Lightcards takes any valid Markdown or HTML table. Each row is a card, and each of the first two columns is a side.
## License
Copyright Armaan Bhojwani 2021, MIT license