branch: externals/marginalia
commit 0c090f310e720385200f5056085b24d216efaf04
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
improve readme
---
README.md | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 704c2a2..2342af9 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,14 @@
-# marginalia.el - Marginalia for completions
+# marginalia.el - Marginalia in the minibuffer
-This package provides `marginalia-mode` which adds marginalia (annotations) to
the minibuffer completions.
-The annotations are added based on the completion category.
-Furthermore the package allows to associate completion categories to commands.
+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. The annotations are added based on the completion category. For
+example `find-file` reports the `file` category and `M-x` reports the `command`
+category. Furthermore the package allows to associate completion categories to
+commands, since many commands (in contrast to `find-file` and `M-x`) do not
+specify a completion category themselves.
