From 511167e9c118926a3d27d4189b7a31106371fc35 Mon Sep 17 00:00:00 2001
From: Tom Willemse
Date: Mon, 17 Oct 2022 22:30:22 -0700
Subject: Add a simple README

---
 README.org | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 README.org

(limited to 'README.org')

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..14b03b7
--- /dev/null
+++ b/README.org
@@ -0,0 +1,15 @@
+#+title: Count Emails
+
+A simple script that counts the number of unread emails in my inbox for display in a status bar like [[https://polybar.github.io/][Polybar]].
+
+* Requirements
+
+This script needs [[https://scsh.net/][scsh]]. It also optionally needs [[https://notmuchmail.org/][notmuch]]. If notmuch isn't installed, it needs [[https://www.gnu.org/software/findutils/][findutils]] instead.
+
+* Installation
+
+Put the =count-emails= script anywhere in your =$PATH=.
+
+* Usage
+
+Run the =count-emails= script without arguments. If notmuch is installed it just asks it how many emails there are tagged =inbox= and =unread=, otherwise it needs one or more [[https://en.wikipedia.org/wiki/Maildir][Maildir]]-format directories to exist in =$HOME/documents/mail=.
-- 
cgit v1.2.3-54-g00ecf