From 0b05fa00aa15c677d48706d30d6006d966d7ea5b Mon Sep 17 00:00:00 2001 From: chenjiahan Date: Sun, 4 Oct 2020 20:00:12 +0800 Subject: [PATCH] docs(@vant/use): add README.md --- packages/vant-use/README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/packages/vant-use/README.md b/packages/vant-use/README.md index b84c2a464..e4aa009d2 100644 --- a/packages/vant-use/README.md +++ b/packages/vant-use/README.md @@ -1 +1,33 @@ # Vant Use + +Vant Use 是 Vant 团队提供的 Vue Composition API 库。 + +## 特性 + +- 从 Vant 实际应用场景中沉淀 +- 基于 TypeScript 开发,提供完备的类型定义 +- 完善的单元测试,提供稳定性保障 + +## 安装 + +如果项目中已经安装了 Vant 3,则无须手动安装 Vant Use。 + +如果项目中未使用 Vant,可以通过 `npm` 或 `yarn` 手动安装 Vant Use。 + +```bash +# 通过 npm 安装 +npm i @vant/use -S + +# 通过 yarn 安装 +yarn add @vant/use +``` + +## 贡献代码 + +修改代码请阅读我们的[开发指南](https://youzan.github.io/vant/#/zh-CN/contribution)。 + +使用过程中发现任何问题都可以提 [Issue](https://github.com/youzan/vant/issues) 给我们,当然,我们也非常欢迎你给我们发 [PR](https://github.com/youzan/vant/pulls)。 + +## 开源协议 + +本项目基于 [MIT](https://zh.wikipedia.org/wiki/MIT%E8%A8%B1%E5%8F%AF%E8%AD%89) 协议,请自由地享受和参与开源。