diff options
1 files changed, 14 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..de650d8
--- /dev/null
+++ b/README
@@ -0,0 +1,14 @@
+maildirlearn helps you training your bogofilter installation. It works fine on
+the local machine (i.e. you’re reading mail on your server) as well as remote
+(i.e. you’re syncing your mail with mbsync/via IMAP).
+There are two versions available: The first one is written in Python and the
+second one in C. Obviously the latter is more efficient while the first one is
+not vulnerable to buffer overflow bugs.
+Both versions currently work for a single user/one maildir only. The mailbox
+format is not supported.