Restructure root and remove Makefile

[lightcards.git] / README.md

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