.update-copyright.conf: convert %(project)s -> {project} formatting

[pyassuan.git] / README

diff --git a/README b/README
index 4f3ef05547b05d5e437e8f6f80eb542e52cc897b..010ece037343011d9a8d8d453bed7af0b158abc8 100644 (file)
--- a/README
+++ b/README
@@ -2,17 +2,11 @@ Python module and tools for communicating in the Assuan_ protocol.
 
 There are a number of GnuPG_ wrappers for python `out there`__, but
 they mostly work via the ``gpg`` executable.  This is an attempt to
-cut to the chase and speak directly to ``gpg-agent``, which offers a
-number of advantages::
+cut to the chase and speak directly to ``gpgme-tool`` (source__) over
+a well-defined socket protocol.
 
 __ wrappers_
-
-* No need to spawn ``gpg`` every time you want to do something
-  cryptographic.
-* No need to `do anything fancy with file descriptors`__ to verify
-  detached signatures.
-
-__ enable-special-filenames_
+__ gpgme-tool_
 
 Installation
 ============
@@ -34,14 +28,14 @@ Dependencies
 ------------
 
 ``pyassuan`` is a simple package with no external dependencies outside
-the Python 3 standard library.
+the Python 3.3 standard library.
 
 Installing by hand
 ------------------
 
-``pgp-mime`` is available as a Git_ repository::
+``pyassuan`` is available as a Git_ repository::
 
-  $ git clone git://tremily.us/pgp-mime.git
+  $ git clone git://tremily.us/pyassuan.git
 
 See the homepage_ for details.  To install the checkout, run the
 standard::
@@ -58,12 +52,17 @@ Testing
 
 Run the internal unit tests using nose_::
 
-  $ nosetests --with-doctest --doctest-tests pgp-mime
+  $ nosetests --with-doctest --doctest-tests pyassuan
 
 If a Python-3-version of ``nosetests`` is not the default on your
 system, you may need to try something like::
 
-  $ nosetests-3.2 --with-doctest --doctest-tests pgp-mime
+  $ nosetests-3.3 --with-doctest --doctest-tests pyassuan
+
+To test running servers by hand, you can use `gpg-connect-agent`_.
+Despite the name, this program can connect to any Assuan server::
+
+  $ gpg-connect-agent --raw-socket name
 
 Licence
 =======
@@ -75,12 +74,14 @@ Author
 ======
 
 W. Trevor King
-wking@drexel.edu
+wking@tremily.us
 
 
 .. _Assuan: http://www.gnupg.org/documentation/manuals/assuan/
 .. _GnuPG: http://www.gnupg.org/
 .. _wrappers: http://wiki.python.org/moin/GnuPrivacyGuard
+.. _gpgme-tool:
+  http://git.gnupg.org/cgi-bin/gitweb.cgi?p=gpgme.git;a=blob;f=src/gpgme-tool.c;hb=HEAD
 .. _enable-special-filenames:
   http://lists.gnupg.org/pipermail/gnupg-devel/2002-November/019343.html
 .. _Gentoo: http://www.gentoo.org/
@@ -89,4 +90,6 @@ wking@drexel.edu
 .. _Git: http://git-scm.com/
 .. _homepage: http://blog.tremily.us/posts/pyassuan/
 .. _nose: http://readthedocs.org/docs/nose/en/latest/
+.. _gpg-connect-agent:
+  http://www.gnupg.org/documentation/manuals/gnupg-devel/gpg_002dconnect_002dagent.html
 .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.html