X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?p=elpher.git;a=blobdiff_plain;f=README.md;h=8d40e7e0ac2fa23b26c9ad19ee3a128828d0cc28;hp=8b927d2fcf66c975afad1f425d4ce777e38ebc7b;hb=bb6fa3a36f8c283d39829bb5adad997b9f9ab3d6;hpb=740346ac89cc83ac29d16b0dc8c2a19b1fe9f4fc

diff --git a/README.md b/README.md
index 8b927d2..8d40e7e 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,81 @@
-# 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:
+- intuitive keyboard and mouse-driven browsing,
+- out-of-the-box compatibility with evil-mode,
+- clickable web and gopher links **in plain text**,
 - caching of visited sites,
-- clean and configurable visualization of Gopher directories,
-- direct visualisation of image files.
+- pleasant and configurable visualization of Gopher directories,
+- direct visualisation of image files,
+- jumping directly to links by name (with autocompletion),
+- a simple bookmark management system,
+- connections using TLS encryption.
+
+Elpher is under active development.  Any suggestions for improvements
+are welcome!
+
+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:
+
+    M-x package-install RET elpher RET
+
+To uninstall, use `M-x package-delete RET elpher RET`.
+
+Quick Start
+-----------
+
+Once installed, use `M-x elpher` to launch the browser.  This will
+open a start page which documents the main key bindings and provides
+some links to help kick start your exploration of gopherspace.
+
+From here you can move point between links (which may be menu items or
+inline URLs in text files) by using `TAB` and `Shift-TAB`,
+as in Info.  You can also jump directly to a menu item using `m`, or
+use the standard Emacs or Evil motion and search commands to find your
+way around.  To open a link, press enter.  (Where a mouse is
+available, Clicking on a link with the mouse cursor has the same
+effect.)
+
+To return to the page you just followed the link from, press `u`.
+
+Elpher caches (for the duration of an Emacs session) both page contents
+and the position of point on each of the pages (gopher menus, query
+results, or text pages) you visit, restoring these when you next visit
+the same page.  Thus, pressing `u` displays the previous page in
+exactly the same state as when you left, meaning that you can quickly
+and visually explore the different documents in a menu without having to
+wait for anything to reload.
+
+Of course, sometimes you'll _want_ to reload the current page
+rather than stick with the cached version.  To do this use `R`.
+(This is particularly useful for search query results, where this
+allows you to perform a different search.)
 
-Much of Elopher is still under development.  Planned features include:
-- support for gopher search engines,
-- optional in-line rendering of image links in directories.
+To customize the various faces Elpher uses, the start page
+and a few other odds and ends, use the following:
 
-Keep the non-web internet alive!
+    M-x customize-group RET elpher RET
 
-## Installation
+Full Documentation
+------------------
 
-Installation instructions will be added soon.
+The full documentation for Elpher can be found in the Info manual,
+which should become automatically available if you install Elpher
+using `M-x package-install`.  To access it, select it from the root
+Info directory which can be displayed using `C-h i`.
 
-## Licence
+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.