X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?a=blobdiff_plain;f=README.md;h=34083368514be441b15290b1a101e2335dc5f7e7;hb=692b730680ee7b2f4f0b1f7b0b68ac4b84d5d8b1;hp=55b693e0b8bd8f0e337ffa6d8be9f04115f6d010;hpb=0c3e78c30bf2e23a54c0eb0324213434b2611255;p=elpher.git

diff --git a/README.md b/README.md
index 55b693e..3408336 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,79 @@
-# Elopher
+# Elpher
 
-Elopher aims to provide a full-featured gopher client for GNU Emacs.
-It currently supports:
-- simple keyboard and mouse-driven browsing,
+Elpher aims to provide a full-featured gopher client for GNU Emacs.
+
+It supports:
+- simple keyboard and mouse-driven browsing, including out-of-the-box
+  compatibility with evil-mode,
 - 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.
 
-Much of Elopher is still under development.  Planned features include:
-- better use of standard faces for better compatibility with different
-  colour schemes,
-- support for multiple Elopher buffers.
-
 Keep the non-web internet alive!
 
 ## Installation
 
-Installation instructions will be added soon.
+To install, simply save the file `elpher.el` and use `M-x
+package-install-file`, specifying the path to the saved elisp file.
+
+To uninstall, use `M-x package-delete`.
+
+## 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.
+
+## History and Caching
+
+This is an aspect of Elpher that perhaps requires separate explanation.
+
+Every item you visit with Elpher is modeled as a "node" in a tree.
+For instance, a gopher directory represents a single node.  When
+you open such a directory, Elpher creates nodes for every entry
+in that directory and makes these children of the original directory node:
+
+               X  <- current directory node
+               |
+            -------
+            |  |  |
+            o  o  o  <- nodes representing entries in directory
+
+If one of those entries is itself a directory and you click on it,
+Elpher marks that node the current node, and extends the tree as follows:
+
+               o  <- original directory node
+               |
+            -------
+            |  |  |
+            o  o  X  <- current directory node (marked with X)
+                  |
+              ---------
+              | | | | |
+              o o o o o  <- nodes representing entries in new directory
+              
+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.
+
+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
 
-Elopher is free software and is distributed under the terms of version
+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
 COPYING.