branch: externals/marginalia commit 3559cbb0e0cfedd5757ee76cf285bdb66fdc4aed Author: Daniel Mendler <m...@daniel-mendler.de> Commit: Daniel Mendler <m...@daniel-mendler.de>
update readme --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 73a50d3..5178dd0 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,13 @@ 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. You can choose between more or less detailed annotators, by -setting the variable `marginalia-annotators`. +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. You can choose between more or less detailed annotators, by setting +the variable `marginalia-annotators` or by invoking the command +`marginalia-cycle-annotators`. Since many commands do not report a completion category themselves, Marginalia provides a classifier system, which tries to guess the correct category based