From: Marius Gavrilescu <marius@ieval.ro>
Date: Thu, 10 Jul 2014 10:40:29 +0000 (+0300)
Subject: Add usage instructions to README
X-Git-Url: http://git.ieval.ro/?p=app-edwardng.git;a=commitdiff_plain;h=2a57ed8d9848a659071816cf93b769576ab6ec06

Add usage instructions to README
---

diff --git a/README b/README
index a024a2a..446dbec 100644
--- a/README
+++ b/README
@@ -14,12 +14,34 @@ To install this module type the following:
    make test
    make install
 
+USAGE
+
+Typical usage of EdwardNG is as follows:
+
+1. Create a new GPG homedir
+   $ mkdir /srv/edwardng
+2. Create a suitable gpg.conf
+   $ cat > /srv/edwardng/gpg.conf <<END
+   no-greeting
+   keyserver hkp://keys.gnupg.net
+   auto-key-locate keyserver
+   keyserver-options auto-key-retrieve
+   END
+3. Generate a new key
+   $ gpg --homedir /srv/edwardng --gen-key
+4. Add an entry to /etc/aliases
+   $ echo 'edwardng: |/path/to/edwardng --keydir=/srv/edwardng --key=KEYID --from=edwardng@hostname.tld' >> /etc/aliases
+   For multiple language support, add multiple entries to /etc/aliases of the form:
+   $ echo 'edwardng-lang: |/path/to/edwardng --keydir=/srv/edwardng --key=KEYID --from=edwardng@hostname.tld --tmpl=lang' >>/etc/aliases
+
 DEPENDENCIES
 
 This module requires these other modules and libraries:
 
  * Email::Sender
  * File::Slurp
+ * File::Share
+ * File::ShareDir::Install
  * MIME-Tools
  * Mail::GnuPG
  * PerlX::Maybe