commit - 7b974ef3c950ea819631b93348dd58f6f7090bdb
commit + 3b9d369b3d4caee6eb93d3e232aa7fe142e161c7
blob - 08eeaa11a579771750b21e218ff10bc334404f47
blob + 6e006763efc9a315de39b479dd09a73fa662af49
--- README.md
+++ README.md
Hustle through a buffer's Imenu in a side window in GNU Emacs.
+Side Hustle works on multiple buffers simultaneously, does not require a
+global minor mode, and does not rely on timers.
+
Installation
------------
Alternatives
------------
-[Imenu-List](https://github.com/bmag/imenu-list)
+Side Hustle takes inspiration primarily from
+[imenu-list](https://github.com/bmag/imenu-list).
blob - ac05e09b6fc382d2fe73c12f31cbea44d054c73d
blob + 62d1d7eca5b783425248d80c4dc8c66d415420d7
--- side-hustle.el
+++ side-hustle.el
;;; Commentary:
-;;
+;; Side Hustle
+;; ===========
+;; Hustle through a buffer's Imenu in a side window in GNU Emacs.
+
+;; Side Hustle works on multiple buffers simultaneously, does not require a
+;; global minor mode, and does not rely on timers.
+
+
+;; Installation
+;; ------------
+
+;; Add something like this to your init file:
+
+;; (define-key (current-global-map) (kbd "M-s l") #'side-hustle-toggle)
+
+
+;; Bugs and Feature Requests
+;; -------------------------
+
+;; Send me an email (address in the package header). For bugs, please
+;; ensure you can reproduce with:
+
+;; $ emacs -Q -l side-hustle.el
+
+;; Known issues are tracked with FIXME comments in the source.
+
+
+;; Alternatives
+;; ------------
+
+;; Side Hustle takes inspiration primarily from
+;; [imenu-list](https://github.com/bmag/imenu-list).
+
;;; Code:
(require 'imenu)
:group 'side-hustle)
(defcustom side-hustle-evaporate-window nil
- "When non-nil, quit the side-window when calling
-`side-hustle-goto-item'."
+ "When non-nil, quit the side window when following link."
:type 'boolean
:safe 'booleanp
:group 'side-hustle)