From 3d125a87bb9fc5e82db1b4c85fceb2ebcc125c93 Mon Sep 17 00:00:00 2001
From: J08nY
Date: Mon, 29 May 2017 19:21:11 +0200
Subject: plugin: Add Django app

---
 plugin.md | 20 +++++++++++++++++---
 1 file changed, 17 insertions(+), 3 deletions(-)

(limited to 'plugin.md')

diff --git a/plugin.md b/plugin.md
index 7bdb9db..a2447b1 100644
--- a/plugin.md
+++ b/plugin.md
@@ -18,15 +18,29 @@
         - `EncryptedOutgoingRunner` - Encrypts and optionally signs for configured lists. This is a runner and not a Pipeline since we need to encrypt all outgoing messages, so digests, virgin messages, posts...
 
      - `archivers`
-        - `EncryptedHyperKittyArchiver` - Fetches list archive public keys from `pgphyperkitty`, uses them to send messages to archive encrypted, for encrypted lists.
+        - `EncryptedHyperKittyArchiver` - Fetches list archive public keys from `django-pgpmailman`, uses them to send messages to archive encrypted, for encrypted lists.
+        - `EncryptedLocalArchiver` - Stores messages encrypted with list-key in maildir format.
 
      - `initialize()` - A callable to be setup in a Mailman hook, to setup everything necessary for pgpmailman to run. Such as adding the `listname-key`@ subaddress, creating keyrings if not found, subscribing to events if necessary.
 
+  * `django-pgpmailman` - A Django app that extends Postorius and HyperKitty, also with an associated example_project that combines Postorius, HyperKitty while extending their templates and views seamlessly.
 
 ## Instalation
 
- * A setuptools package that needs to be installed into the same virtualenv as the Mailman 3 instance.
+### Core plugin
+
+A setuptools package that needs to be installed into the same virtualenv as the Mailman 3 instance.
+
+### Django app
+
+A setuptools package that needs to be installed into the same virtualenv as the Postorius and HyperKitty instances, packaged with an example_project.
 
 ## Configuration
 
- * Custom runners, archivers and other site configuration options would need to be set.
\ No newline at end of file
+### Core plugin
+
+Custom runners, archivers and other site configuration options would need to be set.
+
+### Django app
+
+As any of Mailman's Django apps, will be packaged with an example_project with default configuration.
\ No newline at end of file
-- 
cgit v1.2.3-70-g09d2