branch: externals/kind-icon
commit eaeea121e3036a3a837842d2b93821ba5b0cd8e3
Author: JD Smith <93749+jdtsm...@users.noreply.github.com>
Commit: JD Smith <93749+jdtsm...@users.noreply.github.com>
Doc
---
README.md | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 07447f3..13bfdf2 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ This emacs package adds icon or text-based completion prefixes
based on the `:co
## Installation
-Get it from melpa (TBD). Enable in any buffer with completion enabled using
`kind-icon-mode`. E.g., to enable for the completion UI
[corfu](https://github.com/minad/corfu):
+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):
```elisp
(use-package kind-icon ;package availability TBD
@@ -15,7 +15,9 @@ Get it from melpa (TBD). Enable in any buffer with
completion enabled using `ki
## Configuration
-Defaults should normally work fine, but some of the important configuration
variables include:
+### Variables
+
+The defaults should normally work fine, but some of the important
configuration variables include:
- `kind-icon-use-icons`: If non-nil (the default), prefer icons for prefix
badges.
@@ -27,3 +29,7 @@ Defaults should normally work fine, but some of the important
configuration vari
`:face` foreground and background (see above) color to use as a custom
background for each badge. A value of 0.0 simply replicates the
background color. Values should likely stay below 0.3 or so.
+
+### Icons and Colors
+
+Check the [material icon library](https://materialdesignicons.com) for the SVG
icons you can use. All you need is the name of the icon! Icon colors are
matched by default to the default colors in programming modes (variables,
function names, etc.). If you don't like the default colors used to go along
with the icons, you can customize the associated face, or build your own. See
`M-x list-faces-display`. You can `M-x customize-group kind-icon` to update
the mapping.
