From c42f49f0eca6df770321327b5c14d55d1082c133 Mon Sep 17 00:00:00 2001 From: J08nY Date: Fri, 14 Jul 2017 22:17:37 +0200 Subject: Update README with some info. --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) (limited to 'README.md') 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 . \ No newline at end of file -- cgit v1.2.3-70-g09d2