[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/marginalia 0c090f3 011/241: improve readme
From: |
Stefan Monnier |
Subject: |
[elpa] externals/marginalia 0c090f3 011/241: improve readme |
Date: |
Fri, 28 May 2021 20:48:47 -0400 (EDT) |
branch: externals/marginalia
commit 0c090f310e720385200f5056085b24d216efaf04
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@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.
![marginalia-mode with
Selectrum](https://github.com/minad/marginalia/blob/main/marginalia-mode.png?raw=true)
- [elpa] externals/marginalia 84f0fde 002/241: add marginalia-command-annotate, (continued)
- [elpa] externals/marginalia 84f0fde 002/241: add marginalia-command-annotate, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia eecc6e2 006/241: Get key binding active in next window instead of in the minibuffer, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 863e07b 004/241: experimental: remove selectrum-specifics (may not work out!), Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia e863b6c 007/241: Show key bindings from minibuffer-selected-window, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 4780a6a 009/241: marginalia works with icomplete-vertical now!, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 237a620 001/241: initial prototype, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia c47576c 010/241: add configuration example, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia a6dfb38 003/241: add todos, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia bdbbee2 005/241: add very basic readme, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 6077206 008/241: Ignore byte-compiled files, autoloads and *-pkg.el files, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 0c090f3 011/241: improve readme,
Stefan Monnier <=
- [elpa] externals/marginalia 80fa320 016/241: Introduce list of classifiers, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia ca21d30 029/241: fix typo in the readme, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 655f03b 035/241: introduce marginalia-annotators-(light|heavy), remove marginalia-set-command-annotator, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 4cb6d2b 039/241: marginalia-annotate-file: add modes, user and group, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia ed74ca9 040/241: add marginalia-toggle-annotators, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 57b1176 051/241: marginalia-annotate-command-binding: only store the binding in the hash table, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 6537c37 015/241: Shorten first line of docstring using our "annotator" term, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 69ec4d7 017/241: Remove unused function, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 28defd6 014/241: Introduce new name "annotator" for annotation functions, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia e2af1d3 019/241: Make marginalia-prompt-categories an alist of regexps and categories, Stefan Monnier, 2021/05/28