aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.org17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..15ab00d
--- /dev/null
+++ b/README.org
@@ -0,0 +1,17 @@
+#+title: Notmuch Tag Mailinglists
+
+A simple script that tags any emails from mailing lists I have subscribed to at some point, to be run as a hook for [[https://notmuchmail.org/][notmuch]].
+
+* Requirements
+
+This script requires [[https://scsh.net/][scsh]] and notmuch.
+
+* Installation
+
+Put the =notmuch-tag-mailinglists= anywhere in your =$PATH=.
+
+* Usage
+
+Call the =notmuch-tag-mailinglists= script without any arguments.
+
+It's recommended that this is done as part of the =post-new= hook of your notmuch configuration.