Add README.md

1 files changed, 52 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aa14465
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+# hatask
+
+Task list manager
+
+## Build
+
+To build, install [hare](https://harelang.org/) and run:
+
+    $ hare build .
+
+## Usage
+
+    ./hatask: tasklist
+
+    Usage: ./hatask [-hpd] [-f <path>] [-c <context>] [-t <tags>]
+
+    -h: print this help text
+    -f <path>: tasks directory
+    -c <context>: context filter
+    -t <tags>: tags filter
+    -p: sort by priority
+    -d: activate debug mode
+
+    Subcommands:
+      filter: filter tasks
+      f: filter tasks
+      show: show task details
+      s: show task details
+      add: add a task
+      a: add a task
+      write: write a task
+      w: write a task
+      done: delete a task
+      d: delete a task
+      tsv: print tsv of tasks
+      t: print tsv of tasks
+
+## Config
+
+hatask uses an ini format config at $XDG\_CONFIG\_HOME/hatask/config.ini.
+
+The list of keys:
+
+* tasksdir: the path to the tasks directory
+* context: an optional context to filter by
+* tags: an optional comma-separated list of tags to filter by
+
+For example:
+
+    tasksdir=/path/to/tasks/folder
+    context=work
+    tags=features