From 7203d2f10393f4bb7b1e5add4aae612ecc692552 Mon Sep 17 00:00:00 2001
From: Tom Willemse
Date: Mon, 17 Oct 2022 22:40:56 -0700
Subject: Add a simple README

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

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..67b0ada
--- /dev/null
+++ b/README.org
@@ -0,0 +1,15 @@
+#+title: Inbox Size
+
+A simple script that counts the number of headings in my inbox file for display in a status bar like [[https://polybar.github.io/][Polybar]].
+
+* Requirements
+
+This script needs [[https://scsh.net/][scsh]] and [[https://www.gnu.org/software/emacs/][Emacs]].
+
+* Installation
+
+Put the =inbox-size= script anywhere in your =$PATH=.
+
+* Usage
+
+Run the =inbox-size= script without arguments. This script assumes that your inbox file is located in =$HOME/documents/gtd/inbox.org=.
-- 
cgit v1.2.3-54-g00ecf