branch: externals/marginalia
commit f083852b63d26120318f71c96c2787fadf4826a6
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
readme: add embark and consult links
---
README.md | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 4d7a2be..923cc88 100644
--- a/README.md
+++ b/README.md
@@ -22,6 +22,14 @@ specified by the variable `marginalia-classifiers`.
## Configuration
+It is recommended to use Marginalia together with either the
+[Selectrum](https://github.com/raxod502/selectrum) or the
+[Icomplete-vertical](https://github.com/oantolin/icomplete-vertical) completion
+system. Furthermore Marginalia can be combined with
+[Embark](https://github.com/oantolin/embark) for action support and
+[Consult](https://github.com/minad/consult), which provides many useful
+commands.
+
~~~ elisp
;; Enable richer annotations using the Marginalia package
(use-package marginalia
@@ -35,7 +43,7 @@ specified by the variable `marginalia-classifiers`.
;; Prefer richer, more heavy, annotations over the lighter default variant.
;; E.g. M-x will show the documentation string additional to the keybinding.
;; By default only the keybinding is shown as annotation.
- ;; Note that there is the command `marginalia-cycle-annotators` to
+ ;; Note that there is the command `marginalia-cycle-annotators` to
;; switch between the annotators.
(setq marginalia-annotators '(marginalia-annotators-heavy
marginalia-annotators-light)))
~~~
