From c4159d895ac399ca55326f7b4ff8bfbf8402e654 Mon Sep 17 00:00:00 2001
From: Jordan <me@jordan.im>
Date: Sat, 4 Feb 2023 23:54:03 -0700
Subject: initial commit

---
 README | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README

(limited to 'README')

diff --git a/README b/README
new file mode 100644
index 0000000..9d77e5a
--- /dev/null
+++ b/README
@@ -0,0 +1,22 @@
+pigeon is a simple RFC-compliant email autoresponder; it monitors IMAP for
+mailbox updates and replies to unseen messages with content rendered from the
+configured template. pigeon supports per-address cooldown timers to prevent mail
+loops, and can ignore messages sent to alias addresses.
+
+pigeon is opinionated and is intended to be configured with accounts used by
+automated systems or unattended (and presently empty) inboxes; it's designed to
+accommodate a particularly narrow use case.
+
+pigeon's idling logic is borrowed from aerc[1] and makes use of emersion's
+well-designed go-imap[2] and go-smtp[3] libraries.
+
+Usage of ./pigeon:
+  -conf string
+        path to JSON configuration (default "./pigeon.json")
+  -eml string
+        path to EML message (default "./message.eml")
+
+[1] https://sr.ht/~rjarry/aerc/
+[2] https://github.com/emersion/go-imap
+[3] https://github.com/emersion/go-smtp
+
-- 
cgit v1.2.3-54-g00ecf