aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJ08nY2017-07-14 22:17:37 +0200
committerJ08nY2017-07-14 22:19:38 +0200
commitc42f49f0eca6df770321327b5c14d55d1082c133 (patch)
treef62e0388d68441ce658ba39ad673805e139cdd36 /README.md
parent0129c437289ac0501c26184a983eab9ef14419c9 (diff)
downloadmailman-pgp-c42f49f0eca6df770321327b5c14d55d1082c133.tar.gz
mailman-pgp-c42f49f0eca6df770321327b5c14d55d1082c133.tar.zst
mailman-pgp-c42f49f0eca6df770321327b5c14d55d1082c133.zip
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 29 insertions, 1 deletions
diff --git a/README.md b/README.md
index c617834..a4615f5 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,31 @@
-# Mailman PGP plugin
+# mailman-pgp
+[![build status](https://gitlab.com/J08nY/mailman-pgp/badges/master/build.svg)](https://gitlab.com/J08nY/mailman-pgp/commits/master) [![coverage report](https://gitlab.com/J08nY/mailman-pgp/badges/master/coverage.svg)](https://gitlab.com/J08nY/mailman-pgp/commits/master)
A plugin for GNU Mailman that adds encrypted mailing lists via PGP/MIME.
+
+## Installation
+
+Simply install into the same environment as Mailman Core and follow configuration steps to enable. For example using:
+```
+pip install mailman-pgp
+```
+
+## Configuration
+
+See [mailman.cfg](src/mailman_pgp/config/mailman.cfg) for example configuration which enables the mailman-pgp plugin in Mailman Core and sets up the plugin configuration to the example [mailman_pgp.cfg](src/mailman_pgp/config/mailman_pgp.cfg).
+
+## License
+
+ Copyright (C) 2017 Jan Jancar
+ This program is free software; you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free
+ Software Foundation, either version 3 of the License, or (at your option)
+ any later version.
+
+ This program is distributed in the hope that it will be useful, but WITHOUT
+ ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ more details.
+
+ You should have received a copy of the GNU General Public License along with
+ this program. If not, see <http://www.gnu.org/licenses/>. \ No newline at end of file