Browse Source

Modify README with client and remailer

and setup.cfg entry points.
master
juga 2 years ago
parent
commit
0527e24e53
2 changed files with 21 additions and 8 deletions
  1. +19
    -6
      README.rst
  2. +2
    -2
      setup.cfg

+ 19
- 6
README.rst View File

@ -1,14 +1,23 @@
remailer
========
_
``remailer`` decrypts an OpenPGP encrypted Email and send it to the
recipient(s) in the decrypted Email.
pEp mix network prototype in Python
===================================
The Email is assumed to be encrypted in several layers as described in
https://dev.pep.foundation/Mixnet/Messages.
This project is a prototype of the pEp mix network design described in
composed by the following:
1. ``client
It encrypts an Email message several times as described in and send it to the
first remailer.
2. ``remailer``
It decrypts an OpenPGP encrypted Email and sends it to the recipient(s)
`in the decrypted Email.
It is intented to run as Postfix pipe.
`Contributing <CONTRIBUTING.md>`__
License
@ -20,3 +29,7 @@ Authors
-------
juga at riseup dot net
https://dev.pep.foundation/Mixnet/Messages.

+ 2
- 2
setup.cfg View File

@ -1,5 +1,5 @@
[metadata]
name = remailer
name = mixnet
description = pEp Python Remailer
author = juga
author_email = juga@riseup.net
@ -56,7 +56,7 @@ dev =
[options.entry_points]
console_scripts =
remailer = mixnet.remailer.cli:main
client = mixnet.client.cli:main
# If there is a pyproject.toml file, use setuptools, since pyproject.toml is
# not the default yet.
[build-system]


Loading…
Cancel
Save