wtsk-comps 1.3.2 → 1.3.3

package/README.md

@@ -1,3 +1,46 @@
-# Vue 3 + Element Plus
+# 一款基于Vue3+Element Plus的后台管理类基础组件库，包含表格、表单、按钮、树组件
 
-开箱即用
+## 注意事项
+- 项目需基于Vue3开发
+- Node.js版本需≥ 20.0.0
+
+## 使用方法
+### 第一步：安装项目所需依赖（已有可忽略）
+```bash
+npm install sass -D
+```
+```bash
+npm install element-plus --save
+```
+注意：element-plus版本需 ≥ 2.11.3
+```bash
+npm install @element-plus/icons-vue --save
+```
+```bash
+npm install wtsk-comps --save
+```
+
+### 第二步：全局引入组件及依赖
+在main.js中引入wtsk-comps组件及相关依赖。
+```javascript
+import { createApp } from 'vue'
+import App from './App.vue'
+import ElementPlus from 'element-plus'
+import 'element-plus/dist/index.css'
+import WtskComps from 'wtsk-comps'
+import 'wtsk-comps/dist/wtsk-comps.css'
+
+const app = createApp(App)
+app.use(ElementPlus).use(WtskComps).mount('#app')
+```
+注意：因组件是基于Element Plus已有组件进行的封装，所以使用时需全局引入element-plus。
+
+### 第三步：项目中直接使用组件
+在项目中直接使用wtsk-comps组件即可，目前支持（wtsk-btn/form/table/tree），使用方式见组件文档。
+```vue
+<template>
+  <div>
+    <wtsk-btn>默认按钮</wtsk-btn>
+  </div>
+</template>
+```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "wtsk-comps",
-  "version": "1.3.2",
-  "description": "基于Vue3+Element Plus的基础组件库（wtsk-btn/form/table/tree）",
+  "version": "1.3.3",
+  "description": "一款基于Vue3+Element Plus的基础组件库（wtsk-btn/form/table/tree）",
   "author": "lujh",
   "license": "MIT",
   "keywords": ["wtsk-comps"],
@@ -9,7 +9,7 @@
   "main": "dist/wtsk-comps.cjs.js",
   "module": "dist/wtsk-comps.es.js",
   "unpkg": "dist/wtsk-comps.umd.js",
-  "style": "dist/wtsk-comps.css",
+  "style": "dist/index.css",
   "exports": {
     ".": {
       "import": "./dist/wtsk-comps.es.js",