X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.md;h=93309015ebb659c223b9cc1c4d7bdc06a9158569;hb=ba91e98b658c41329e283a033a0be61348756a99;hp=b9250f9ddbc9ff65017e25885c8fb90f600d6483;hpb=691525d47e162525a9f0a179c02dab493cbea940;p=lightcards.git

diff --git a/README.md b/README.md
index b9250f9..9330901 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,25 @@
 # lightcards
 Terminal flashcards from Markdown.
 
-# Installation
-`make`
+## Installation
+### From PyPI
+```
+pip install lightcards
+```
 
-# Usage
-see `lightcards --help`
+### 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