Dummy version bump.

[elpher.git] / README.md

diff --git a/README.md b/README.md
index e3f7763..af0c184 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
-# Elpher
+Elpher
+======
 
 Elpher aims to provide a full-featured gopher client for GNU Emacs.
 
@@ -9,25 +10,36 @@ It supports:
 - 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.
+- clickable web and gopher links in plain text,
+- a simple bookmark management system.
 
-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.
 
-Installation instructions will be added soon.
+To install Elpher, enter the following:
 
-## Usage
+    M-x package-install RET elpher RET
+
+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.
 
@@ -59,17 +71,21 @@ 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.
+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.
+key. When it is viewed, the bookmark page also becomes a part of this
+hierarchy.
 
-## Licence
+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