branch: elpa/xkcd
commit 7987d64a7e85613abe715d9b06d2b3b0c4d09edb
Author: Vibhav Pant <vibh...@gmail.com>
Commit: Vibhav Pant <vibh...@gmail.com>
* README.md: Remove. Replaced with README.org.
---
README.md | 49 -------------------------------------------------
1 file changed, 49 deletions(-)
diff --git a/README.md b/README.md
deleted file mode 100644
index 1c17eb941e..0000000000
--- a/README.md
+++ /dev/null
@@ -1,49 +0,0 @@
-emacs-xkcd
-==========
-
-[](https://travis-ci.org/vibhavp/emacs-xkcd)
-
-Implementation of an xkcd (http://xkcd.com/) reader for Emacs.
-
-#Installation
-
-## Via package.el (Melpa)
-emacs-xkcd is now available on [Melpa](http://melpa.milkbox.net). If you have
added Melpa as a repository, the package can be installed by a simple `M-x
package-install xkcd`.
-
-## Via Github
-Clone this repository to a desired location, and add the following snippet to
your .emacs:
-```lisp
-(add-to-list 'load-path (expand-file-name "/path/to/emacs-xkcd.el"))
-(require 'xkcd)
-```
-#Screenshot:
-![alt text][screen]
-[screen]: http://i.imgur.com/x08oyQm.png "Screenshot of emacs-xkcd"
-
-#Loading comics:
-`xkcd-get` loads up a user-specified comic.
-
-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.
-
-#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` |
-
-
-#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>` | Load previous xkcd | (xkcd-prev) |
-
-#TODO
-Add support for custom faces.
-Handle links to xkcd in Emacs with xkcd-get.
\ No newline at end of file
