installation and usage

README.md

@@ -1 +1,24 @@
 # journal
+
+## Usage
+
+```sh
+usage: journal [-h] [--journal-dir JOURNAL_DIR] [--editor EDITOR] {create,edit}
+
+Journal
+
+positional arguments:
+  {create,edit}         Command to run (create a new entry, or view and edit an existing one)
+
+options:
+  -h, --help            show this help message and exit
+  --journal-dir JOURNAL_DIR
+                        Path to your journal directory (default from JOURNAL_DIR env or ~/.journal)
+  --editor EDITOR       Editor to use (default $EDITOR or nano)
+```
+
+## Installation
+
+With `python3` installed, create a symlink from `journal.py` to a directory on your $PATH.
+
+E.g. `ln -s ./journal.py ~/.local/bin/journal`