Added requirements section.

[elisp/epg.git] / README

diff --git a/README b/README
index 187db0d..d191cdb 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,14 @@
 * What's this?
 
-EasyPG is yet another GnuPG interface for Emacs.  It consists of a
-transparent file encryption application and easy-to-use elisp library
-to interact with GnuPG.
+EasyPG is yet another GnuPG interface for Emacs.  It consists of two
+parts: transparent file encryption utility and easy-to-use elisp
+library to interact with GnuPG.
+
+* Requirements
+
+** GNU Emacs 21.4 or later
+** XEmacs 21.4 or later
+** GnuPG 1.4.3 or later
 
 * Quick start
 
@@ -23,8 +29,11 @@ subprocess "gpg".  So, your passphrases may leak to the filesystem.
 *** There is no way to clear strings safely.
 To prevent passphrases from been stealing from cores, `read-passwd'
 function clears passphrase strings by `(fillarray string 0)'.
-However, it is not enough.  In GC sweep phase, Emacs does compaction
-on small strings.  If GC happens before `fillarray', passphrase
-strings may be copied elsewhere in the memory.
-
-PGG and gpg.el enables passphrase caching by default.
+However, it is not enough.  Emacs does compaction of small strings in
+GC sweep phase.  If GC happens before `fillarray', passphrase strings
+may be copied elsewhere in the memory.  PGG and gpg.el enables
+passphrase caching by default.
+
+** Most GnuPG features can be accessible from Emacs
+As the name says, EasyPG is inspired by GPGME (GnuPG Made Easy), and
+the API is close to GPGME.
\ No newline at end of file