aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--readme.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/readme.rst b/readme.rst
new file mode 100644
index 0000000..4054e79
--- /dev/null
+++ b/readme.rst
@@ -0,0 +1,14 @@
+Cute Little Innocent Mailing List
+=================================
+
+climl is a simple mailing list compatible with any server supporting imap or
+lmtp. I know these two protocols are not always brought together for mailing
+list management, but this mailing list can be deployed in two modes:
+
+- client mode: In this mode you can plug the manager on any remote server
+ supporting the IMAP protocol. The client will listen for incomming e-mail
+ and send it to the **climl** server listenning in lmtp.
+
+- server mode: In this mode **climl** listen in lmtp (unix socket). A MTA,
+ such as postfix for example, can send mails directly to it. In this mode, we
+ just do not start the client bridge.