Browse files

Deprecate project.

  • Loading branch information...
1 parent fc08f2a commit f196079938bb3a980796e4f7929649a7eccf0180 @candera committed Dec 13, 2012
Showing with 8 additions and 36 deletions.
  1. +8 −36 README.md
View
44 README.md
@@ -2,39 +2,11 @@
A global minor mode for emacs that will show what keys you've typed in a window.
-## Caveat Hacker
-
-I whipped this together in a giant hurry, but it seems to be stable enough.
-
-## Installation
-
-In your `.emacs`:
-
-```elisp
-(add-to-list 'load-path "/path/to/dir-with-show-keys.el/")
-(require 'show-keys)
-```
-
-## Use
-
-```elisp
-M-x show-keys-mode
-```
-
-This will create a buffer called `*shown-keys*` which will show the
-keys you've typed. Note that it ignores any commands in
-`show-keys-ignored-commands`, which by default includes
-`self-insert-command`. This keeps the output from being too noisy.
-
-It's not super-sophisticated, but it does catch most things. It's
-handy for screencasts or for pairing with someone who doesn't know
-emacs that well and is wondering what you're typing. It's also
-occasionally handy for figuring out what the heck you just did.
-
-## Screenshot
-![screenshot](https://raw.github.com/candera/show-keys.el/master/screenshot.jpg)
-
-## Credits
-
-Thanks to [Stuart Sierra](http://twitter.com/stuartsierra) for an
-assist with some of the weird bits.
+## Deprecation Notice
+
+*N.B.* After I wrote this,
+ [Jeff Weiss](https://plus.google.com/s/ergoemacs) pointed out
+ [mwe-log-commands](http://www.emacswiki.org/emacs-zh/CommandLogMode)
+ to me. As that does everything show-keys.el does and is more mature,
+ I'm deprecating this project. Go get that one if you need what this
+ does!

0 comments on commit f196079

Please sign in to comment.