branch: externals/marginalia
commit c47576cf1a9a03af46722f8639647477c4ff9622
Author: Daniel Mendler <[email protected]>
Commit: Daniel Mendler <[email protected]>
add configuration example
---
README.md | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
diff --git a/README.md b/README.md
index a17d30b..704c2a2 100644
--- a/README.md
+++ b/README.md
@@ -5,3 +5,24 @@ The annotations are added based on the completion category.
Furthermore the package allows to associate completion categories to commands.
+
+## Configuration
+
+~~~ elisp
+;; Enable richer annotations using the Marginalia package
+(use-package marginalia
+ ;; The :init configuration is always executed (Not lazy!)
+ :init t
+
+ ;; Must be in the :init section of use-package such that the mode gets
+ ;; enabled right away. Note that this forces loading the package.
+ (marginalia-mode)
+
+ ;; Enable richer annotations for M-x.
+ ;; Only keybindings are shown by default, in order to reduce noise for this
very common command.
+ ;; * marginalia-annotate-symbol: Annotate with the documentation string
+ ;; * marginalia-annotate-command-binding (default): Annotate only with the
keybinding
+ ;; * marginalia-annotate-command-full: Annotate with the keybinding and the
documentation string
+ ;; (setf (alist-get 'command marginalia-annotate-alist)
#'marginalia-annotate-command-full)
+)
+~~~
