Update README

[lightcards.git] / README.md

diff --git a/README.md b/README.md
index 0a1b5dc4cfe8eee574a151efb721d19d8f7a4af2..d9ba139524820ccaa9d0314a037bf177fd76fc72 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,25 @@
 # 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
+```
+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 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