[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/kind-icon be77196 19/51: Update README.md

From: ELPA Syncer
Subject: [elpa] externals/kind-icon be77196 19/51: Update README.md
Date: Wed, 17 Nov 2021 15:57:42 -0500 (EST)

branch: externals/kind-icon
commit be771962c5920357436c961cbab71b4f7a17d8c0
Author: JD Smith <93749+jdtsmith@users.noreply.github.com>
Commit: GitHub <noreply@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:

reply via email to

[Prev in Thread] Current Thread [Next in Thread]