branch: elpa/xkcd
commit e0b7938714d0d782e1f81d1d8f4d1cf8797f46d7
Author: Vibhav Pant <vibh...@gmail.com>
Commit: Vibhav Pant <vibh...@gmail.com>
Add docs for xkcd-handle-links.
---
README.md | 15 ++++++++++++---
xkcd.el | 2 +-
2 files changed, 13 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 59c3b3167c..3ff84b1666 100644
--- a/README.md
+++ b/README.md
@@ -19,13 +19,22 @@ Clone this repository to a desired location, and add the
following snippet to yo
#Screenshot:
![alt text][screen]
[screen]: http://i.imgur.com/x08oyQm.png "Screenshot of emacs-xkcd"
-#Loading up comics:
+
+#Loading comics:
`xkcd-get` loads up a user-specified comic.
-Files are cached by default to ~/.emacs.d/xkcd/. This can be changed by
changing `xkcd-cache-dir` in the group "xkcd". (customize-group xkcd)
+Files are cached (for later offline viewing) by default to ~/.emacs.d/xkcd/.
This can be changed by changing `xkcd-cache-dir` in the group "xkcd".
(customize-group xkcd)
`xkcd` loads up the latest xkcd.
-# Current keybindings:
+
+#Customization
+emacs-xkcd can be customized with `M-x customize-group xkcd`. The
customization options are:
+| Option | Use
| Default value |
+|:-------------------:|:---------------------------------------------------------:|:------------------------:|
+| `xkcd-cache-dir` | Directory where images and json files are cached
| `~/.emacs.d/xkcd/` |
+| `xkcd-cache-latest` | File where the number of the latest cached xkcd is
stored | `~/.emacs.d/xkcd/latest` |
+| `xkcd-handle-links` | If t, handle xkcd links by opening them with xkcd-get
| `t` |
+#Keybindings:
| Keybinding | Use | Function |
|:----------:|:------------------------------:|:--------------:|
| `r` | Load a random xkcd | (xkcd-rand) |
diff --git a/xkcd.el b/xkcd.el
index fae45d0e03..b9d54247c6 100644
--- a/xkcd.el
+++ b/xkcd.el
@@ -67,7 +67,7 @@ Should preferably be located in `xkcd-cache-dir'."
:type 'file)
(defcustom xkcd-handle-links t
- "Handle xkcd links by opening them with xkcd-get"
+ "If t, Handle xkcd links by opening them with xkcd-get"
:group 'xkcd
:type 'boolean)
