Bump version to 0.4.0

[lightcards.git] / README.md

diff --git a/README.md b/README.md
index 0a1b5dc4cfe8eee574a151efb721d19d8f7a4af2..8c7ebd73b6a44cb4c0fc2c1a874ee4f69517a62d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,16 @@
 # lightcards
-Lightcards is a simple terminal program for creating flashcards from a markdown table
+Terminal flashcards from Markdown.
+
+## Installation
+Switch to newest version: `git checkout $(git tag | tail -n 1)`, or use the current development state.
+
+`make` to install for the current user, or `make global` to install for the whole system.
+
+## Usage
+see `lightcards --help`
+
+## Input file
+See `contrib/example.md` for an example input file
 
 ## License
 Copyright Armaan Bhojwani 2021, MIT license