branch: externals/kind-icon
commit ea06e81b30a261899972b66893577cb025835ca6
Author: JD Smith <[email protected]>
Commit: GitHub <[email protected]>
Update README.md
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index bd577e8..6f307f4 100644
--- a/README.md
+++ b/README.md
@@ -62,7 +62,7 @@ The configuration defaults should work fine, but kind-icon
can be customized to
- `kind-icon-use-icons`: If non-nil (the default), prefer icons for prefix
badges. Otherwise, use text labels. Individual kind entries can also have
their icons disabled by removing the `:icon` property in the mapping (see
below). If `svg-lib` is unable to download a named icon and it is not cached
on disk, text labels for that kind will be used as a fallback.
-- `kind-icon-mapping`: This is the top level configuration mapping
`:company-kind` "types" like `'variable` and `'function`. Each item in this
list has the format `(sym short-text :keyword value ...)` where `sym` is the
kind (a symbol), and `short-text` is the abbreviated text to display (if icons
are not used). The rest of the list is a property list with optional keys
`:icon` and `:face`. The latter will be used to set the text foreground and
(possibly) background colors on the badg [...]
+- `kind-icon-mapping`: This is the top level configuration mapping
`:company-kind` "types" like `'variable` and `'function`. Each item in this
list has the format `(sym short-text :keyword value ...)` where `sym` is the
kind (a symbol), and `short-text` is the abbreviated text to display (if icons
are not used), both of which must be present. The rest of the list is a
property list with optional keys `:icon` and `:face`. The latter will be used
to set the text foreground and (possibly [...]
- `kind-icon-default-face`: A face from which the icon background color will
be taken and blended with the `:face` foreground color in the mapping table to
create a custom background color. If not set, the frame default background
color will be used for this purpose. Similarly, the foreground color for this
face, if set, will be used if a `:face` foreground is missing from the mapping.
