Add simple READMEHEADmaster

1 files changed, 19 insertions, 0 deletions

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..26de715
--- /dev/null
+++ b/README.org
@@ -0,0 +1,19 @@
+#+title: Notmuch Collect Tasks
+
+A simple script that searches through the [[https://notmuchmail.org/][notmuch]] database and sees if any need to be turned into tasks to be put in my Getting Things Done inbox file, to be run as a hook for notmuch.
+
+* Requirements
+
+This script needs [[https://scsh.net/][scsh]] and notmuch.
+
+* Installation
+
+Put the =notmuch-collect-tasks= anywhere in your =$PATH=.
+
+* Usage
+
+Call the =notmuch-collect-tasks= script with the location of your inbox file as the only argument, for example:
+
+: notmuch-collect-tasks ~/documents/gtd/inbox.org
+
+It's recommended that this is done as part of the =post-new= hook of your notmuch configuration.