From 3effbaf08027f8fd88f9e92d22e2f7f359491e7e Mon Sep 17 00:00:00 2001 From: justbur Date: Sun, 2 Aug 2015 19:33:24 -0400 Subject: [PATCH] Add README intro to commentary section. --- which-key.el | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/which-key.el b/which-key.el index a1bab6ed629..f992a5435d8 100644 --- a/which-key.el +++ b/which-key.el @@ -23,8 +23,18 @@ ;;; Commentary: -;; This is a rewrite of guide-key https://github.com/kai2nenobu/guide-key. See -;; https://github.com/justbur/emacs-which-key for more information. +;; which-key is a minor mode for Emacs that displays the key bindings following +;; your currently entered incomplete command (a prefix) in a popup. For example, +;; after enabling the minor mode if you enter C-x and wait for the default of 1 +;; second the minibuffer will expand with all of the available key bindings that +;; follow C-x (or as many as space allows given your settings). This includes +;; prefixes like C-x 8 which are shown in a different face. Screenshots of what +;; the popup will look like along with information about additional features can +;; be found at https://github.com/justbur/emacs-which-key. +;; +;; which-key started as a rewrite of guide-key +;; (https://github.com/kai2nenobu/guide-key), but the feature sets have since +;; diverged. ;;; Code: