X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?a=blobdiff_plain;f=README.md;h=0600fd3ed7e9c14e8ed3ca0e6303f8d828399e51;hb=2f33f5ec76fddcafff5d792d59110b31ad2de533;hp=6f7f620cfe1ee14c015780ea4cbd0a4cfbd091c1;hpb=c5326528d6d3997c23259bf85b900543f07516c8;p=elpher.git

diff --git a/README.md b/README.md
index 6f7f620..0600fd3 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
-# Elpher
+Elpher
+======
 
 Elpher aims to provide a full-featured gopher client for GNU Emacs.
 
@@ -8,29 +9,38 @@ It supports:
 - caching of visited sites,
 - clean and configurable visualization of Gopher directories,
 - direct visualisation of image files,
+- jumping directly to links by name (with autocompletion),
 - clickable web and gopher links in plain text.
 
-Elpher is still under development.  Planned features include:
-- (m)enu key support, similar to the Emacs info browser,
-- support for multiple Elpher buffers.
-
 Keep the non-web internet alive!
 
-## Installation
+Installation
+------------
+
+Elpher is available from [MELPA](https://melpa.org).  If you have
+never installed packages from this repository before, you'll need
+to follow the instructions at https://melpa.org/#/getting-started.
+
+To install Elpher, enter the following:
 
-Installation instructions will be added soon.
+    M-x package-install RET elpher RET
 
-## Usage
+To uninstall, use `M-x package-delete RET elpher RET`.
+
+Usage
+-----
 
 Once installed, use `M-x elpher` to launch the browser.  This will
 open a start page which documents the default key bindings and
 provides some links to help kick start your exploration of gopherspace.
 
 To customize the various faces Elpher uses, the start page
-and a few other odds and ends, simply use `M-x customize-group`
-and enter "elpher" at the group prompt.
+and a few other odds and ends, use the following:
+
+    M-x customize-group RET elpher RET
 
-## History and Caching
+History and Caching
+-------------------
 
 This is an aspect of Elpher that perhaps requires separate explanation.
 
@@ -58,17 +68,24 @@ Elpher marks that node the current node, and extends the tree as follows:
               | | | | |
               o o o o o  <- nodes representing entries in new directory
               
-Pressing the 'u' button (introduced on page which opens when elopher starts)
+Pressing the 'u' key (introduced on page which opens when elopher starts)
 always moves to the page representing "parent" node, whatever that is.
 
 Once a node is visited, its "contents" (i.e. whatever is retrieved
-from the gopher server) are recorded with the corresponding node.  The
-cursor position (point) is also stored. If the node is visited again,
-the cached contents are displayed and the cursor returns to its
-previous position.  This makes navigating amongst different documents
-referenced from within the same directory very snappy.
-
-## Licence
+from the gopher server) are recorded in memory with the corresponding
+node.  The cursor position (point) is also stored. If the node is
+visited again in the same session, the cached contents are displayed
+and the cursor returns to its previous position.  This makes
+navigating amongst different documents referenced from within the same
+directory very snappy. (To conserve memory, this caching isn't by
+default applied to images entries viewed in the browser.)
+
+This hierarchy is also maintained when gopher URLs are followed from plain
+text documents, and when directories are retrieved explicitly using the 'g'
+key.
+
+Licence
+-------
 
 Elpher is free software and is distributed under the terms of version
 3 the GNU General Public License, which can be found in the file named