Skip to content

Commit

Permalink
docs: 增加readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xuasir committed Mar 1, 2021
1 parent 66f4f46 commit cd5acdc
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 12 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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`)打包
7 changes: 4 additions & 3 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# `cli`

> TODO: description
插件化脚手架

## Usage

```
const cli = require('cli');
npm i @xus.cli
// TODO: DEMONSTRATE API
cmd:
xus <sub-cmd> [options]
```
10 changes: 1 addition & 9 deletions packages/core/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
# `cli`

> TODO: description
## Usage

```
const cli = require('cli');
// TODO: DEMONSTRATE API
```
脚手架核心代码

0 comments on commit cd5acdc

Please sign in to comment.