From 3e55747cf3e9877ed30646d13dde35f7c6f0e0a5 Mon Sep 17 00:00:00 2001
From: haoziqaq <357229046@qq.com>
Date: Mon, 23 Nov 2020 14:31:35 +0800
Subject: [PATCH] =?UTF-8?q?fix(=E6=B7=BB=E5=8A=A0tsconfig.json=E5=88=B0cli?=
 =?UTF-8?q?=E7=9A=84=E4=BE=9D=E8=B5=96=E5=88=97=E8=A1=A8):=20tsconfig.json?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

affects: @varlet/cli, @varlet/ui
---
 packages/varlet-cli/README.md    | 24 ++++++++++++++++++++++++
 packages/varlet-cli/package.json |  3 ++-
 packages/varlet-ui/package.json  |  3 +++
 3 files changed, 29 insertions(+), 1 deletion(-)
 create mode 100644 packages/varlet-cli/README.md

diff --git a/packages/varlet-cli/README.md b/packages/varlet-cli/README.md
new file mode 100644
index 00000000000..e516bd078de
--- /dev/null
+++ b/packages/varlet-cli/README.md
@@ -0,0 +1,24 @@
+# varlet cli
+varlet cli是一个基于vue3的组件库构建命令行，可以快速搭建一个基于vue单文件组件的UI组件库
+
+## 快速上手
+```
+npm安装:npm i typescript vue@3.0.2 vue-router@4.0.0-rc.1 @varlet/cli -D
+yarn安装:yarn add typescript vue@3.0.2 vue-router@4.0.0-rc.1 @varlet/cli -D
+```
+
+```
+添加如下代码到package.json
+"scripts": {
+  "dev": "varlet-cli dev",
+  "build": "varlet-cli build",
+  "compile": "varlet-cli compile",
+  "compile:watch": "varlet-cli compile --watch",
+  "create": "varlet-cli create",
+  "jest": "varlet-cli jest"
+},
+"peerDependencies": {
+  "vue": "3.0.2"
+}
+```
+
diff --git a/packages/varlet-cli/package.json b/packages/varlet-cli/package.json
index db4d8b98faf..a684a937bd0 100644
--- a/packages/varlet-cli/package.json
+++ b/packages/varlet-cli/package.json
@@ -15,7 +15,8 @@
   "files": [
     "lib",
     "site",
-    "varlet.default.config.js"
+    "varlet.default.config.js",
+    "tsconfig.json"
   ],
   "repository": {
     "type": "git",
diff --git a/packages/varlet-ui/package.json b/packages/varlet-ui/package.json
index 7c9cd0c1f0d..3c33ca6ed8c 100644
--- a/packages/varlet-ui/package.json
+++ b/packages/varlet-ui/package.json
@@ -32,5 +32,8 @@
     "create": "varlet-cli create",
     "jest": "varlet-cli jest"
   },
+  "peerDependencies": {
+    "vue": "3.0.2"
+  },
   "gitHead": "5dabda353dc88340816ddc6f6ac8081c0680908f"
 }