branch: externals/kind-icon commit be771962c5920357436c961cbab71b4f7a17d8c0 Author: JD Smith <93749+jdtsm...@users.noreply.github.com> Commit: GitHub <nore...@github.com>
Update README.md --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fa80dad..5fdb026 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,24 @@ # kind-icon -Supplies a _kind_ icon or short-text prefix for emacs completion in the buffer. - This emacs package adds icon or text-based completion prefixes based on the `:company-kind` property many completion backends (such as lsp-mode) provide. It works either as a "kind-formatter" function (e.g. for corfu) or by wrapping the completion function for other completion UI's which handle the Emacs 28+ `affixation-function` completion property. +## Examples + +- **`kind-icon` with [corfu](https://github.com/minad/corfu) and [orderless](https://github.com/oantolin/orderless), from [lsp-mode](https://github.com/emacs-lsp/lsp-mode) :** + +  + +- **With text-based icons:** + +  + +- **Blended background color disabled:** + +  + +- **Mix of text and icons:** + +  + ## Installation Get it from melpa (TBD), which should install `svg-lib` as well if necessary. Enable in any buffer with completion using `kind-icon-mode`. E.g., to enable for the completion UI [corfu](https://github.com/minad/corfu), which has a kind-formatter configuration: