Follow XDG_CACHE_HOME

[lightcards.git] / README.md

diff --git a/README.md b/README.md
index 93309015ebb659c223b9cc1c4d7bdc06a9158569..84fd20b8b2c4042a753d245af337684858243841 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,18 +8,24 @@ pip install lightcards
 ```
 
 ### From Git
+#### Main branch (stable)
 ```
-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 .
+pip install git+https://git.sr.ht/~armaan/lightcards
+```
+
+#### Development branch
+```
+pip install git+https://git.sr.ht/~armaan/lightcards@devel
 ```
 
 ## Usage
-See `lightcards --help` for usage information.
+See `lightcards --help` or `man lightcards` 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.
+`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.
+
+## Configuration
+Copy the config file at `/etc/lightcards/config.py` to `~/.config/lightcards/config.py` or `~/${XDG_CONFIG_HOME}/lightcards/config.py` and edit.
 
 ## License
 Copyright Armaan Bhojwani 2021, MIT license