branch: externals/marginalia
commit 2864c8efc90a39352db7752dc38006e826e2e70f
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
fix #31
---
README.md | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 5178dd0..7f2c797 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,9 @@ This package provides `marginalia-mode` which adds marginalia
to the minibuffer
completions. [Marginalia](https://en.wikipedia.org/wiki/Marginalia) are marks
or
annotations placed at the margin of the page of a book or in this case helpful
colorful annotations placed at the margin of the minibuffer for your completion
-candidates.
+candidates. Marginalia can only add annotations to be displayed with the
+completion candidates. It cannot modify the appearance of the candidates
+themselves, which are shown as supplied by the original commands.
The annotations are added based on the completion category. For example
`find-file` reports the `file` category and `M-x` reports the `command`
