|
|
@@ -1 +1,31 @@
|
|
|
-# NutUI组件库vscode插件
|
|
|
+# NutUI 组件库 vscode 插件
|
|
|
+
|
|
|
+开发本插件旨在帮助开发者更加有效率的使用 NutUI 来开发项目
|
|
|
+
|
|
|
+## 特征
|
|
|
+
|
|
|
+- 快速查看文档
|
|
|
+- 代码自动补全
|
|
|
+
|
|
|
+## 文档
|
|
|
+
|
|
|
+### 用法
|
|
|
+
|
|
|
+1、移动鼠标到 NutUI 的标签上
|
|
|
+2、能够看到除了提示的 TS 类型之外,还有一行查看当前组件文档的提示,点击可以跳转到对应组件的文档,方便开发者查阅
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+## 自动补全
|
|
|
+
|
|
|
+1、在输入 `nut-` 时,会出现组件列表提示,这时,可选择任意需要的组件,然后点击回车自动补全,省时又省力~
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+## 贡献
|
|
|
+
|
|
|
+您的 pull request 将使得我们的插件更加完善。
|
|
|
+
|
|
|
+## 许可
|
|
|
+
|
|
|
+MIT
|