Update README

[lightcards.git] / README.md

diff --git a/README.md b/README.md
index 8c7ebd73b6a44cb4c0fc2c1a874ee4f69517a62d..d9ba139524820ccaa9d0314a037bf177fd76fc72 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,15 +2,24 @@
 Terminal flashcards from Markdown.
 
 ## Installation
-Switch to newest version: `git checkout $(git tag | tail -n 1)`, or use the current development state.
+### From PyPI
+```
+pip install lightcards
+```
 
-`make` to install for the current user, or `make global` to install for the whole system.
+### 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`
+See `lightcards --help` for usage information.
 
 ## Input file
-See `contrib/example.md` for an example 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