From cd5acdcef56cef691cb90fb37ad0f0fe1e8f8441 Mon Sep 17 00:00:00 2001
From: "guo.xu" <xuguo@outlook.it>
Date: Mon, 1 Mar 2021 11:26:38 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E5=A2=9E=E5=8A=A0readme?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md               | 15 +++++++++++++++
 packages/cli/README.md  |  7 ++++---
 packages/core/README.md | 10 +---------
 3 files changed, 20 insertions(+), 12 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5920bc7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+## `@xus/cli`
+
+插件化的脚手架内核
+
+## 特性
+
+1. 高度插件化：所有功能基于插件实现，`@xus/core`实现了脚手架的核心生命周期，并且是所有能力都插件化
+
+2. 跨插件的`hook`机制：基于`tapable`的`hook`调用机制，挂载于核心`service`实现跨插件的`hook`联动
+
+3. `import from one`: 所有内容均从`@xus/cli`包导出
+
+## 默认`lib`打包能力
+
+默认的`preset`中包含了基于`rollup`的类库打包器，自动嗅探项目环境实现`js/ts/vue/react`(支持`jsx`)打包
diff --git a/packages/cli/README.md b/packages/cli/README.md
index 5ed7bd3..f49ca15 100644
--- a/packages/cli/README.md
+++ b/packages/cli/README.md
@@ -1,11 +1,12 @@
 # `cli`
 
-> TODO: description
+插件化脚手架
 
 ## Usage
 
 ```
-const cli = require('cli');
+npm i @xus.cli
 
-// TODO: DEMONSTRATE API
+cmd:
+xus <sub-cmd> [options]
 ```
diff --git a/packages/core/README.md b/packages/core/README.md
index 5ed7bd3..a46afa0 100644
--- a/packages/core/README.md
+++ b/packages/core/README.md
@@ -1,11 +1,3 @@
 # `cli`
 
-> TODO: description
-
-## Usage
-
-```
-const cli = require('cli');
-
-// TODO: DEMONSTRATE API
-```
+脚手架核心代码