[Nym3-commit] r367 - trunk

[laurent at conuropsis.org]

Author: laurent
Date: 2005-10-31 17:54:01 +0100 (Mon, 31 Oct 2005)
New Revision: 367

Added:
   trunk/README
Modified:
   trunk/MANIFEST
Log:
We didn't have a single line of instruction or something so a README file was
in order.


Modified: trunk/MANIFEST
===================================================================
--- trunk/MANIFEST	2005-10-30 10:06:21 UTC (rev 366)
+++ trunk/MANIFEST	2005-10-31 16:54:01 UTC (rev 367)
@@ -17,3 +17,4 @@
 bin/nymbarond
 nymbaron/doc/nymbaron.xml
 nymbaron/doc/nymbarond.xml
+README

Added: trunk/README
===================================================================
--- trunk/README	2005-10-30 10:06:21 UTC (rev 366)
+++ trunk/README	2005-10-31 16:54:01 UTC (rev 367)
@@ -0,0 +1,35 @@
+This is nymbaron version 0.1.0
+
+I. OVERVIEW
+===========
+
+A nymserver is a mail server which stores emails on behalf of
+anonymous users. It provides long-term pseudonymous identities which
+can receive and send emails through the server, without revealing the
+user controling those identities.
+
+This nymserver is built upon the mixminion remailer network.
+
+WARNING: this is still considered alpha quality software. Do NOT use it if you
+require strong anonymity.
+
+This package contains client and server binaries.
+
+Homepage: http://www.komite.net/laurent/soft/nymbaron/
+
+II. HOW TO INSTALL
+==================
+
+$ python setup.py build
+$ xmlto man nymbaron/doc/nymbaron.xml
+$ xmlto man nymbaron/doc/nymbarond.xml
+# python setup.py install
+
+III. HOW TO USE
+===============
+
+The binary command for the client to send/receive pseudoynmous emails
+is called `nymbaron' and is explained in the nymbaron.1 manpage.
+
+The binary command for the server is called `nymbarond' and is
+explained in the nymbarond.8 manpage.