From 104d37c7aac59c3c55d1d5f99ca497fb4285b9ed Mon Sep 17 00:00:00 2001
From: ale <ale@incal.net>
Date: Sat, 6 Feb 2021 22:52:51 +0000
Subject: [PATCH] Add a small README

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..97201ed
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+feedback-loop
+===
+
+
+This small server receives spam feedback loop messages, as sent from
+large email providers in ARF format, and stores the entries in a
+database so that you can see aggregates and details via a web
+interface. Records are periodically expunged from the database if they
+are older than a certain time period.
+
+Due to the common tendency to report mailing list emails as spam, the
+tool tries to identify reports for mailing lists emails, and presents
+their statistics separately from those about emails from ordinary
+users (which are often indicative of an account takeover). Details
+(i.e. the message body) for mailing list emails are not saved to the
+database to save space and effort.
+
-- 
GitLab