New experimental plugin 'secure mail'

[friendica-addons.git] / securemail / README.md

diff --git a/securemail/README.md b/securemail/README.md
new file mode 100644 (file)
index 0000000..2f24c53
--- /dev/null
+++ b/securemail/README.md
@@ -0,0 +1,11 @@
+Secure Mail
+-----------
+
+Send notification mails to user encrypted with GPG.
+Each user can enable it and submit his public key under Settings-> Addon 
+-> "Secure Mail" Settings.
+
+Use 'php-gpg' library, a pure PHP implementation of GPG/PGP, released 
+under GPL. See [project repo](https://github.com/jasonhinkle/php-gpg).
+
+This plugin need Friendica version > 3.3.2 to work.