From 41d6b5191d42d9f0d50a43156526265d78283b38 Mon Sep 17 00:00:00 2001 From: neverland Date: Sat, 30 Jul 2022 21:43:56 +0800 Subject: [PATCH] docs: update readme (#10868) --- README.md | 4 ++-- README.zh-CN.md | 2 +- packages/vant-cli/README.zh-CN.md | 3 ++- packages/vant/docs/markdown/home.en-US.md | 3 ++- packages/vant/docs/markdown/home.zh-CN.md | 1 + packages/vant/package.json | 2 +- packages/vant/vant.config.mjs | 2 +- 7 files changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b8af6f9d4..4843d6ca0 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,13 @@

Vant

-

Mobile UI Components built on Vue

+

Lightweight Mobile UI Components built on Vue

npm version CI Status Coverage Status downloads - Jsdelivr Hits Gzip Size

@@ -29,6 +28,7 @@ - 🚀 1KB Component average size (min+gzip) - 🚀 70+ High quality components +- 🚀 Zero third-party dependencies - 💪 90%+ Unit test coverage - 💪 Written in TypeScript - 📖 Extensive documentation and demos diff --git a/README.zh-CN.md b/README.zh-CN.md index bb83e980a..a1e5b4de2 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -11,7 +11,6 @@ CI Status Coverage Status downloads - Jsdelivr Hits Gzip Size

@@ -33,6 +32,7 @@ Vant 是一个**轻量、可靠的移动端组件库**,于 2017 年开源。 - 🚀 性能极佳,组件平均体积小于 1KB(min+gzip) - 🚀 70+ 个高质量组件,覆盖移动端主流场景 +- 🚀 零外部依赖,不依赖三方 npm 包 - 💪 使用 TypeScript 编写,提供完整的类型定义 - 💪 单元测试覆盖率超过 90%,提供稳定性保障 - 📖 提供丰富的中英文文档和组件示例 diff --git a/packages/vant-cli/README.zh-CN.md b/packages/vant-cli/README.zh-CN.md index 02b2889c5..cb8f72123 100644 --- a/packages/vant-cli/README.zh-CN.md +++ b/packages/vant-cli/README.zh-CN.md @@ -1,9 +1,10 @@ # Vant CLI -Vant CLI 是一个 Vue 组件库构建工具,通过 Vant CLI 可以快速搭建一套功能完备的 Vue 组件库。 +Vant CLI 是一个基于 Vite 实现的 Vue 组件库构建工具,通过 Vant CLI 可以快速搭建一套功能完备的 Vue 组件库。 ### 特性 +- 基于 Vite 实现,享受愉悦的开发体验 - 提供丰富的命令,涵盖从开发测试到构建发布的完整流程 - 基于约定的目录结构,自动生成优雅的文档站点和组件示例 - 内置 ESLint 校验规则,提交代码时自动执行校验 diff --git a/packages/vant/docs/markdown/home.en-US.md b/packages/vant/docs/markdown/home.en-US.md index da8020fe8..c4c642869 100644 --- a/packages/vant/docs/markdown/home.en-US.md +++ b/packages/vant/docs/markdown/home.en-US.md @@ -2,7 +2,7 @@

Vant

-

Mobile UI Components built on Vue

+

Lightweight Mobile UI Components built on Vue

@@ -10,6 +10,7 @@ - 🚀 1KB Component average size (min+gzip) - 🚀 70+ High quality components +- 🚀 Zero third-party dependencies - 💪 90%+ Unit test coverage - 💪 Written in TypeScript - 📖 Extensive documentation and demos diff --git a/packages/vant/docs/markdown/home.zh-CN.md b/packages/vant/docs/markdown/home.zh-CN.md index 540d68240..100a5973f 100644 --- a/packages/vant/docs/markdown/home.zh-CN.md +++ b/packages/vant/docs/markdown/home.zh-CN.md @@ -16,6 +16,7 @@ Vant 是一个**轻量、可靠的移动端组件库**,于 2017 年开源。 - 🚀 性能极佳,组件平均体积小于 1KB(min+gzip) - 🚀 70+ 个高质量组件,覆盖移动端主流场景 +- 🚀 零外部依赖,不依赖三方 npm 包 - 💪 使用 TypeScript 编写,提供完整的类型定义 - 💪 单元测试覆盖率超过 90%,提供稳定性保障 - 📖 提供丰富的中英文文档和组件示例 diff --git a/packages/vant/package.json b/packages/vant/package.json index 4b573d92a..e241c5cec 100644 --- a/packages/vant/package.json +++ b/packages/vant/package.json @@ -1,7 +1,7 @@ { "name": "vant", "version": "3.5.2", - "description": "Mobile UI Components built on Vue", + "description": "Lightweight Mobile UI Components built on Vue", "main": "lib/vant.cjs.js", "module": "es/index.mjs", "style": "lib/index.css", diff --git a/packages/vant/vant.config.mjs b/packages/vant/vant.config.mjs index e19d17078..2b4207fc4 100644 --- a/packages/vant/vant.config.mjs +++ b/packages/vant/vant.config.mjs @@ -458,7 +458,7 @@ export default { 'en-US': { title: 'Vant 3', subtitle: ' (for Vue 3)', - description: 'Mobile UI Components built on Vue', + description: 'Lightweight Mobile UI Components built on Vue', logo: 'https://fastly.jsdelivr.net/npm/@vant/assets/logo.png', langLabel: 'EN', links: [