From 5e9acf6f30accb492233c159c5feeebcf0bcae3c Mon Sep 17 00:00:00 2001
From: Tom Willemsen
Date: Thu, 2 Aug 2012 22:22:34 +0200
Subject: Add some documentation

---
 avandu.el | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

(limited to 'avandu.el')

diff --git a/avandu.el b/avandu.el
index 5b36451..4b76de0 100644
--- a/avandu.el
+++ b/avandu.el
@@ -23,7 +23,26 @@
 
 ;;; Commentary:
 
-;; Still coming...
+;; Avandu is an emacs mode that connects to a Tiny Tiny RSS instance
+;; and allows you to read the feeds it has gathered locally.
+
+;; The simplest way to install it is to use package.el:
+
+;;     (package-install-file "/path/to/avandu.el")
+
+;; For further information I would like to refer you to the avandu
+;; info file.
+
+;; Once installation is out of the way, it should get a value for
+;; `avandu-tt-rss-api-url' (for example: http://tt-rss.org/demo/api/)
+;; and then run `avandu-list'.
+
+;; Once in avandu:overview mode some key bindings will be:
+
+;; - `r' :: Mark article at point as read.
+;; - `o' :: Open article at point in a browser.  Uses `browse-url'.
+;; - `n' :: Next article.
+;; - `p' :: Previous article.
 
 ;;; Code:
 (require 'json)
-- 
cgit v1.2.3-54-g00ecf