diff options
author | 2012-08-02 22:22:34 +0200 | |
---|---|---|
committer | 2012-08-02 22:22:34 +0200 | |
commit | 5e9acf6f30accb492233c159c5feeebcf0bcae3c (patch) | |
tree | 9354408022880a6b118a7decc445a8126ad1d01e /avandu.el | |
parent | b138eea72387b0d9d87d5089603152780ba78bd1 (diff) | |
download | avandu-5e9acf6f30accb492233c159c5feeebcf0bcae3c.tar.gz avandu-5e9acf6f30accb492233c159c5feeebcf0bcae3c.zip |
Add some documentation
Diffstat (limited to 'avandu.el')
-rw-r--r-- | avandu.el | 21 |
1 files changed, 20 insertions, 1 deletions
@@ -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) |