Update README.md

README.md

@@ -1,31 +1,28 @@
-Taskwarrior.el
+# Taskwarrior.el
-==============
+An interactive emacs frontend for taskwarrior.
-An emacs frontend for taskwarrior.
 
+> NOTE: **This major mode is under heavy infrequent development.**
 
-Annotations
+## Installation
------------
+Eventually my goal is to make taskwarrior.el available through MELPA. Currently I simply load the
-Taskwarrior already has the option to add annotations to a task.
+necessary elisp through:
 
-(taskwarrior-create-task-from-dired-file)
+``` emacs-lisp
-(taskwarrior-create-task-from-mu4e-mail)
+(use-package taskwarrior
-
+  :init
-Capture Templates
+  (load "~/yourcheckout/taskwarrior.el")
------------------
+  :bind
-With taskwarrior you often spending way to many keystrokes on capturing metadata around a new task
+  (("C-x t" . taskwarrior)
-(Especially if you are a heavy user of UDA's). Capture templates to the rescue:
+   ("C-x t" . taskwarrior)))
-
-```
-(taskwarrior-capture
-  "Work task"
-  "context:work customer:? project:?)
 ```
 
-The `?` automatically present autocompletion options based on `task _unique` in case of UDA or `task _...`
+## Configuration
+TBD
 
+## Development
+While developing we don't want taskwarrior.el to mess with our taskwarrior tasks. That's why we use
+[direnv](https://direnv.net/) to export $TASKRC and $TASKDATA to point to the git repository.
 
-Review
+With direnv you can either launch emacs within the
-------
+taskwarrior.el repository to make use of the mentioned einvironment variables or use the excellent
-Quiet often you want to review a list of different
+[emacs-direnv mode](https://github.com/wbolster/emacs-direnv) to make emacs direnv aware.
-(taskwarrior-review
-	'("contex:work" "context:school")