Updated README.
[elpher.git] / README.md
index 6f7f620..d8a45a9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,17 +8,22 @@ 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 instructions will be added soon.
+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, using the following:
+
+    M-x package-install RET elpher RET
+
+To uninstall, use `M-x package-delete RET elpher RET`.
 
 ## Usage
 
@@ -58,7 +63,7 @@ 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
@@ -68,6 +73,10 @@ 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.
 
+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