[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) :**
+
+
![image](https://user-images.githubusercontent.com/93749/141227979-9f22cbb6-8029-42f1-86b4-f4cdd03636b2.png)
+
+- **With text-based icons:**
+
+
![image](https://user-images.githubusercontent.com/93749/141225205-9a718be8-f352-451f-892b-aaacae1eeaf6.png)
+
+- **Blended background color disabled:**
+
+
![image](https://user-images.githubusercontent.com/93749/141227004-e4514961-245c-4aa0-888a-65c0a1b63757.png)
+
+- **Mix of text and icons:**
+
+
![image](https://user-images.githubusercontent.com/93749/141228094-8f3364b8-09d0-4e17-860d-221ea9de989c.png)
+
## 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:
- [elpa] externals/kind-icon b88e809 48/51: kind-formatter -> margin-formatters, (continued)
- [elpa] externals/kind-icon b88e809 48/51: kind-formatter -> margin-formatters, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon f6de892 37/51: Remove add-variable-watcher in favor of custom :set, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 94ff0ac 13/51: customize interface for mappings, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon cfa3d73 38/51: Guard against network or other icon retrieval issues (text fallback), ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon ba0f94e 17/51: Re-enable mapping customization preview button, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 0921fe2 35/51: Separate kind-icon--cache, and return ?? when kind missing, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 0d92763 31/51: add kinds constructor, event, reference, typeparameter, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon c69da89 18/51: Updated docs, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 962c209 20/51: Add custom variable watcher for instant updates, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon c0d50c6 40/51: minor reformat, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon be77196 19/51: Update README.md,
ELPA Syncer <=
- [elpa] externals/kind-icon ea06e81 47/51: Update README.md, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon dce91ac 49/51: Update README.md, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 4896e1e 32/51: Switch module & ruler icons, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 21a2861 34/51: Require svg-lib, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 12aa1a9 42/51: Mention how to clear cache, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 8087c8e 44/51: Update README.md, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon ba37562 09/51: more docs, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon f080f3d 15/51: Remove minor mode in favor of c-in-r-f wrapper function, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon b88965b 28/51: Update README.md, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon ab3c6d5 24/51: Expand material icon description and mention text-based icons, ELPA Syncer, 2021/11/17