From bcc6868c061b621fe0e9b63dbe82d422e208cada Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=99=88=E5=98=89=E6=B6=B5?= Date: Thu, 22 Aug 2019 11:55:05 +0800 Subject: [PATCH] docs: update README.md of sub-packages --- packages/vant-cli/README.md | 23 +++++++++++++++++++++++ packages/vant-markdown-vetur/README.md | 14 ++++++++++++++ packages/vant-touch-emulator/README.md | 12 ++++++++++-- packages/vant-waterfall/README.md | 12 ++++++++++-- 4 files changed, 57 insertions(+), 4 deletions(-) create mode 100644 packages/vant-cli/README.md diff --git a/packages/vant-cli/README.md b/packages/vant-cli/README.md new file mode 100644 index 000000000..b1e84a2f3 --- /dev/null +++ b/packages/vant-cli/README.md @@ -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 +``` diff --git a/packages/vant-markdown-vetur/README.md b/packages/vant-markdown-vetur/README.md index b48663a47..855ee6f53 100644 --- a/packages/vant-markdown-vetur/README.md +++ b/packages/vant-markdown-vetur/README.md @@ -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 diff --git a/packages/vant-touch-emulator/README.md b/packages/vant-touch-emulator/README.md index 27d1cbabd..af85279e7 100644 --- a/packages/vant-touch-emulator/README.md +++ b/packages/vant-touch-emulator/README.md @@ -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 +``` + ## 使用指南 直接在代码中引入模块即可，模块会自动完成初始化并生效 diff --git a/packages/vant-waterfall/README.md b/packages/vant-waterfall/README.md index dba91971e..2ea3f7cd8 100644 --- a/packages/vant-waterfall/README.md +++ b/packages/vant-waterfall/README.md @@ -1,11 +1,19 @@ # Waterfall 瀑布流 -### 安装 +### Install -```bash +#### NPM + +```shell npm i @vant/waterfall -S ``` +#### YARN + +```shell +yarn add @vant/waterfall +``` + ### 使用指南 #### 全局注册