initial README.rst

1 files changed, 43 insertions, 0 deletions

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..5005af5
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,43 @@
+mm3mod: Command line list moderation for mailman3
+=================================================
+
+Installation
+------------
+
+Install with your favourite python package manager (not so well
+tested), or just copy ``mm3mod/__install_.py`` to a nicer name in your
+path and run it as a script.
+
+Configuration
+-------------
+
+Create $XDG_CONFIG_DIR/mm3mod/config.ine with at least
+
+.. code-block:: ini
+   
+   [rest]
+   password=<your REST admin password>
+
+   [list]
+   name=<fqdn>
+
+The password is output by ``mailman info`` or ``mailmain-wrapper info``
+
+Use
+---
+
+Run
+
+::
+
+   $ mm3mod
+
+This will put you in a loop that
+
+1. Prints the first page of held messages
+2. Allows you to ``accept`` or ``discard`` by request-id, or to discard the whole page.
+
+Other useful commands include ``quit`` and ``help``
+
+Tab completion is available for commands and request-ids.
+