branch: externals/kind-icon
commit 5defd8695ee92bf16caaa4a99649177bd982f194
Author: JD Smith <[email protected]>
Commit: JD Smith <[email protected]>
Clean up install info
---
README.md | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index aacae14..f6ac419 100644
--- a/README.md
+++ b/README.md
@@ -23,7 +23,11 @@ A few examples of `kind-icon` in action:
## 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:
+Get it from melpa (TBD). Note that icons support requires
[svg-lib](https://github.com/rougier/svg-lib). At present `kind-icon` has been
tested extensively with [corfu](https://github.com/minad/corfu).
+
+### Using kind-formatter:
+
+To enable for the completion UI [corfu](https://github.com/minad/corfu), which
has a kind-formatter configuration:
```elisp
(use-package kind-icon ;package availability TBD
@@ -34,6 +38,8 @@ Get it from melpa (TBD), which should install `svg-lib` as
well if necessary. E
(corfu-kind-formatter #'kind-icon-formatted))
```
+### Wrapping completion-in-region
+
The more generic approach of wrapping the `completion-in-region-function`
would look like:
```elisp
@@ -47,6 +53,8 @@ The more generic approach of wrapping the
`completion-in-region-function` would
completion-in-region-function)))))
```
+For whichever completion-ui you are using.
+
## Configuration
The configuration defaults should work fine, but kind-icon can be customized
to change the colors, preference of icons vs. short-text (or mixed) prefixes,
and more.
