X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.md;h=9bc7879b87a73b2caa46a853538a07433b454ac7;hb=ae89ff9e73baee789bcfa1c914da8e29feb2dc04;hp=560b692421f5d28955457c788417a5fb1e7b9e69;hpb=7121c7107bcb4b3ef7a78878abf02c2e68354bf6;p=lightcards.git

diff --git a/README.md b/README.md
index 560b692..9bc7879 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,23 @@
 # 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