From b22e4e448b4d04e4ce7b0c0329d30fa9ab9fac6e Mon Sep 17 00:00:00 2001 From: Tom Willemse Date: Sun, 5 Jan 2014 16:13:38 +0100 Subject: [PATCH] Update commentary --- transient-navigation.el | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/transient-navigation.el b/transient-navigation.el index 5f60474..d485174 100644 --- a/transient-navigation.el +++ b/transient-navigation.el @@ -21,7 +21,24 @@ ;;; Commentary: -;; +;; Ease navigation by providing a minor mode that enables a transient +;; key map whenever certain navigation commands are specified. + +;; The `transient-navigation-mode' and +;; `global-transient-navigation-mode' minor modes can be used to +;; enable this mode either locally or globally. + +;; More keybindings can be added to your liking by using the +;; `transnav-make-transient' macro. With this macro You can specify +;; the key to use while the transient keymap is enabled, which map you +;; would like to have activated and which function you would like it +;; to replace and put in the transient keymap. + +;; Currently the variables `transient-C-navigation-map' and +;; `transient-M-navigation-map' are provided, which try to extend the +;; Control and Meta (Alt) prefixed navigation commands. You can +;; easily add your own by creating a keymap and passing it as the MAP +;; parameter to `transnav-make-transient'. ;;; Code: