Skip to content

Commit 1621619

Browse files
committed
docs: update readme
1 parent b8f4ad4 commit 1621619

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
1-
# antd-design-token README
1+
# antd design token
22

3-
VS Code extension for antd v5 design token.
3+
VSCode extension for antd v5 design token.
44

55
## Features
66

7-
中文
7+
Provide the hover hint of antd v5 design token, include `color`, `value`.
88

9-
1. 提供 antd design token 的 hover 值提示,例如:`颜色``数值`
10-
2. 输入时提示 token 值,注意,为了使值提示出现在提示区域前面,在输入 token 前可以先输入一个 `a`。例如输入 `padding...`,可以输入 `apadding...`,这并不会影响确定后插入的变量。
9+
![hover](assets/hover.gif)
1110

12-
## Command
11+
Support completion for antd v5 design token value on typing. Note that for sorting, you can type an `a` before typing the token. For example, if you want to type `padding...`, you can type `apadding...`. Which will not affect the variable inserted after the enter keydown.
1312

14-
你可以使用 `antd-design-token:toggle` 命令来激活或者关闭此插件。
13+
![typing](assets/type.gif)
14+
15+
## Commands
16+
17+
You can use command: `antd-design-token:toggle` to active or inactive this extension.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "antd-design-token",
33
"displayName": "antd Design Token",
4-
"description": "VS Code extension for antd v5 design token.",
4+
"description": "VSCode extension for antd v5 design token.",
55
"version": "0.1.1",
66
"publisher": "shezhangzhang",
77
"engines": {

0 commit comments

Comments
 (0)