branch: externals/kind-icon
commit 15de78d56ada4af39b45009e7b70e3ca2dc24271
Author: JD Smith <[email protected]>
Commit: GitHub <[email protected]>
Update README.md
---
README.md | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 61d0a1a..aacae14 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,15 @@
-# kind-icon — Rich icons for in-buffer completion
-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.
+# kind-icon — colorful icons for completion in Emacs
+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 (for supporting UI's such as
corfu) or by wrapping the completion function for other completion UI's which
can 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) :**
+A few examples of `kind-icon` in action:
+
+- **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:**
+- **Using text-based icons:**
