Update.

[epg/epg.git] / README

diff --git a/README b/README
index b68e86c..a704fb2 100644 (file)
--- a/README
+++ b/README
@@ -1,14 +1,32 @@
 * What's this?
 
-EasyPG is a GnuPG interface for Emacs.  It has two aspects: convenient
-tools which allow to use GnuPG from Emacs (EasyPG Assistant), and a
-fully functional interface library to GnuPG (EasyPG Library.)
+EasyPG is an all-in-one GnuPG interface for Emacs.  It has two
+aspects: convenient tools which allow to use GnuPG from Emacs (EasyPG
+Assistant), and a fully functional interface library to GnuPG (EasyPG
+Library).
+
+* Features
+
+The EasyPG Assistant provides the following features:
+
+- Keyring browser.
+- Cryptographic operations on regions.
+- Cryptographic operations on files.
+- Dired integration.
+- Encryption/decryption of *.gpg files.
+
+The EasyPG Library provides the following features:
+
+- The API covers most functions of GnuPG like GPGME.
+- S/MIME support using gpgsm.
+- Designed to avoid potential security pitfalls around Emacs
 
 * Requirements
 
-** GNU Emacs 21.4 or XEmacs 21.4
+** GNU Emacs 21.4, XEmacs 21.4, or later
 
-** GnuPG 1.4.3
+** GnuPG 1.4.3 or later
+   Earlier versions are supported but not recommended.
 
 * Quick start
 
@@ -21,8 +39,13 @@ Add the following line to your ~/.emacs
 
   (require 'epa-setup)
 
-Then you can browse your keyring by `M-x epa-list-keys'.  In addition,
-you can do some cryptographic operations on dired.
+Restart emacs and type `M-x epa- TAB', and you will see a lot of
+commands available.  For example,
+
+- To browse your keyring, type `M-x epa-list-keys'
+- To create a cleartext signature of the region, type `M-x epa-sign-region'
+
+You can also do some cryptographic operations from dired.
 
   M-x dired
   (mark some files)
@@ -32,16 +55,13 @@ you can do some cryptographic operations on dired.
 * MUA Integration
 
 The EasyPG Library can be used in combination with various MUA (Mail
-User Agents.)
+User Agents).
 
 ** CVS version of Gnus
 
-CVS version of Gnus supports EasyPG natively.  To use, simply put the
-following line into your ~/.emacs.
-
-  (setq mml2015-use 'epg)
-
-Other options which affect on the binding are
+CVS version of Gnus uses EasyPG by default.  To make sure of that,
+check mml2015-use set to 'epg.  Other options which affect on the
+EasyPG are
 
   mml2015-signers
   mml2015-encrypt-to-self
@@ -55,16 +75,20 @@ NOTE: You don't need pgg-epg.el in this case.
 
 PGG is outdated PGP library used by old Gnus (<= v5.11), MH-E, etc.
 
-There is a PGG backend written EasyPG called pgg-epg.el.  However,
-EasyPG API is a superset of PGG and pgg-epg.el provides nothing but
-compatibility with PGG.
+There is a PGG backend written using EasyPG called pgg-epg.el.
+However, EasyPG API is a superset of PGG and pgg-epg.el provides
+nothing but compatibility with PGG.
+
+*** Limitations of PGG
 
-Limitations of PGG
+As I noted "PGG is outdated PGP library" above, PGG has several
+limitations.  For example
 
-- PGG doesn't have a user interface to select keys for typical
-  cryptographic operations
-- PGG can't handle messages signed with multiple keys correctly
-- PGG trusts any keys for encryption
+- PGG can't handle a message signed with multiple keys.
+- PGG can't prompt a user which key is being used.
+- PGG can't create a binary PGP messages.
+- PGG doesn't provide a way to select keys per cryptographic operation.
+- PGG ignores GnuPG's trust metrics.
 
 ** SEMI based MUA