docs: update README.md of sub-packages

This commit is contained in:
陈嘉涵 2019-08-22 11:55:05 +08:00
parent 8cca48131e
commit bcc6868c06
4 changed files with 57 additions and 4 deletions

View File

@ -0,0 +1,23 @@
# Vant Cli
## Install
#### NPM
```shell
npm i @vant/cli -D
```
#### YARN
```shell
yarn add @vant/cli --dev
```
## Commands
#### Build Changelog
```shell
vant changelog ./name.md
```

View File

@ -2,6 +2,20 @@
将 .md 文件转换成能描述 vue 组件的 .json 文件,供 vscode 插件 *vetur* 读取,从而可以在 vue 模版语法中拥有自动补全的功能。
## Install
#### NPM
```shell
npm i @vant/markdown-vetur -D
```
#### YARN
```shell
yarn add @vant/markdown-vetur --dev
```
## API
#### parseAndWrite

View File

@ -2,12 +2,20 @@
在桌面端上模拟移动端 touch 事件,实现方式来自于 [hammerjs/touchemulator](https://github.com/hammerjs/touchemulator).
## 安装
## Install
```bash
#### NPM
```shell
npm i @vant/touch-emulator -S
```
#### YARN
```shell
yarn add @vant/touch-emulator
```
## 使用指南
直接在代码中引入模块即可,模块会自动完成初始化并生效

View File

@ -1,11 +1,19 @@
# Waterfall 瀑布流
### 安装
### Install
```bash
#### NPM
```shell
npm i @vant/waterfall -S
```
#### YARN
```shell
yarn add @vant/waterfall
```
### 使用指南
#### 全局注册