[nongnu] elpa/xkcd 046ad2c582 67/82: Add README.org

[ELPA Syncer]

branch: elpa/xkcd
commit 046ad2c5828132ee2ecb63d23bae5cea9a02beda
Author: Vibhav Pant <vibh...@gmail.com>
Commit: Vibhav Pant <vibh...@gmail.com>

    Add README.org
---
 README.org | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)

diff --git a/README.org b/README.org
new file mode 100644
index 0000000000..b2d2828cd3
--- /dev/null
+++ b/README.org
@@ -0,0 +1,51 @@
+#+TITLE: emacs-xkcd 
+#+STARTUP: inlineimages
+
+[[https://travis-ci.org/vibhavp/emacs-xkcd][https://travis-ci.org/vibhavp/emacs-xkcd.png]]
+
+Implementation of an [[https://xkcd.com][xkcd]] reader for GNU Emacs.
+
+* Installation
+** Via package.el:
+   emacs-xkcd is available on [[http://melpa.milkbox.net][MELPA]] and 
[[https://marmalade-repo.org/][Marmalade]]. Just add any
+   of these to your package archives, and install the package with 
+   ~M-x package-install xkcd~.
+** Via Git
+   Clone this repo to a desired location, add the directory to your load path:
+   #+BEGIN_SRC lisp
+(add-to-list 'load-path (expand-file-name "/path/to/emacs-xkcd"))
+(require 'xkcd)
+   #+END_SRC
+
+* Screenshot:
+  [[./images/screenshot.png]]
+
+* Viewing comics:
+  + ~xkcd-get~ loads a user-specific xkcd.
+  Files are cached (for later offline viewing) by default to 
~~/.emacs.d/xkcd/~.
+  This can be changed by changing ~xkcd-cache-dir~ in emacs-xkcd's customize 
menu. 
+  (~customize-group xkcd~)
+  
+  + ~xkcd~ loads the latest xkcd.
+
+* Customization
+  
+  emacs-xkcd can be customized with ~M-x customize-group xkcd~.
+  | Option              | Use                                                  
| Default value            |
+  
|---------------------+------------------------------------------------------+--------------------------|
+  | ~xkcd-cache-dir~    | Directory where images and json files are cached     
| ~~/.emacs.d/xkcd/~       |
+  | ~xkcd-cache-latest~ | File where the latest cached xkcd's number is stored 
| ~~/.emacs.d/xkcd/latest~ |
+
+* Keybindings:
+  
+  | Keybinding | Use                             | Function        |
+  |------------+---------------------------------+-----------------|
+  | =r=        | Load a random xkcd              | (xkcd-rand)     |
+  | =t=        | Show alt-text in the minibuffer | (xkcd-alt-text) |
+  | =<right>=  | Load next xkcd                  | (xkcd-next)     |
+  | =<left>=   | Loads previous xkcd             | (xkcd-prev)     |
+
+ 
+* Stuff yet to be added:
+** TODO View title in user-defined faces.
+** TODO Handle links to xkcd in Emacs with xkcd-get.