docs(vant-cli): translate README to en (#10519)

2022-04-18 18:24:11 +08:00
parent bc1228b312
commit 13fea24739
2 changed files with 92 additions and 18 deletions
@@ -0,0 +1,71 @@
+# Vant CLI
+
+Vant CLI 是一个 Vue 组件库构建工具，通过 Vant CLI 可以快速搭建一套功能完备的 Vue 组件库。
+
+### 特性
+
+- 提供丰富的命令，涵盖从开发测试到构建发布的完整流程
+- 基于约定的目录结构，自动生成优雅的文档站点和组件示例
+- 内置 ESLint、Stylelint 校验规则，提交代码时自动执行校验
+- 构建后的组件库默认支持按需引入、主题定制、Tree Shaking
+
+### 快速上手
+
+执行以下命令可以快速创建一个基于 Vant CLI 的项目：
+
+```bash
+yarn create vant-cli-app
+```
+
+### 手动安装
+
+```shell
+# 通过 npm
+npm i @vant/cli -D
+
+# 通过 yarn
+yarn add @vant/cli -D
+
+# 通过 pnpm
+pnpm add @vant/cli -D
+```
+
+安装完成后，请将以下配置添加到 package.json 文件中
+
+```json
+{
+  "scripts": {
+    "dev": "vant-cli dev",
+    "test": "vant-cli test",
+    "lint": "vant-cli lint",
+    "build": "vant-cli build",
+    "prepare": "husky install",
+    "release": "vant-cli release",
+    "build-site": "vant-cli build-site"
+  },
+  "lint-staged": {
+    "*.md": "prettier --write",
+    "*.{ts,tsx,js,vue,less,scss}": "prettier --write",
+    "*.{ts,tsx,js,vue}": "eslint --fix",
+    "*.{vue,css,less,scss}": "stylelint --fix"
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": ["@vant"]
+  },
+  "stylelint": {
+    "extends": ["@vant/stylelint-config"]
+  },
+  "prettier": {
+    "singleQuote": true
+  },
+  "browserslist": ["Chrome >= 51", "iOS >= 10"]
+}
+```
+
+## 详细文档
+
+- [命令](https://github.com/youzan/vant/tree/dev/packages/vant-cli/docs/commands.md)
+- [配置指南](https://github.com/youzan/vant/tree/dev/packages/vant-cli/docs/config.md)
+- [目录结构](https://github.com/youzan/vant/tree/dev/packages/vant-cli/docs/directory.md)
+- [更新日志](https://github.com/youzan/vant/tree/dev/packages/vant-cli/changelog.md)