X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.md;h=4dd7dc9e62f960bc86207e04e1bb1bbb58b3be2f;hb=86eaf8495475ffb986efcd7fbf11ada2835c88e4;hp=0a1b5dc4cfe8eee574a151efb721d19d8f7a4af2;hpb=09185557a67a1216b9c61d7a7055f347632df07d;p=lightcards.git

diff --git a/README.md b/README.md
index 0a1b5dc..4dd7dc9 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,28 @@
 # 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
+#### Main branch (stable)
+```
+pip install git+https://git.sr.ht/~armaan/lightcards
+```
+
+#### Development branch
+```
+pip install git+https://git.sr.ht/~armaan/lightcards@devel
+```
+
+## Usage
+See `lightcards --help` or `man lightcards` 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