diff --git a/README_zh-CN.md b/README-zh_CN.md similarity index 93% rename from README_zh-CN.md rename to README-zh_CN.md index ed1172ee4..2361542f6 100644 --- a/README_zh-CN.md +++ b/README-zh_CN.md @@ -19,7 +19,9 @@

-TDesign 适配桌面端的组件库,适合在 vue 2.x 技术栈项目中使用。 +简体中文 | [English](./README.md) + +TDesign 适配桌面端的组件库,适合在 Vue 2.x 技术栈项目中使用。 # 🎉 特性 @@ -29,15 +31,14 @@ TDesign 适配桌面端的组件库,适合在 vue 2.x 技术栈项目中使用 - 支持暗黑模式及其他主题定制 - 支持按需加载 -# 安装 +# 📦 安装 ```shell npm i tdesign-vue ``` -# 基础使用 +# 🔨 基础使用 -推荐使用 Webpack 或 Rollup 等支持 tree-shaking 特性的构建工具,无需额外配置即可实现组件按需引入: ```js import Vue from 'vue'; diff --git a/README.md b/README.md index 77e8bd335..cf51781db 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,12 @@ English | [简体中文](./README-zh_CN.md) -TDesign Vue is a UI component library for vue 2 and desktop application. +TDesign Vue is a UI component library for Vue 2 and desktop application. # 🎉 Features - Desktop application interaction -- High quality UI components for Vue 2.0 (< Vue 2.7) +- High quality UI components for Vue 2.x (< Vue 2.7) - Consistent API and UI with TDesign component libraries for other frameworks - Dark mode and customizable theme - Support tree-shaking @@ -37,13 +37,12 @@ TDesign Vue is a UI component library for vue 2 and desktop application. npm i tdesign-vue ``` -# Usage - +# 🔨 Usage ```js import Vue from 'vue'; import TDesign from 'tdesign-vue'; -// import global css resource + import 'tdesign-vue/es/style/index.css'; Vue.use(TDesign); @@ -53,7 +52,7 @@ The package of tdesign-vue provides kinds of bundles, read [the documentation](h # Quick Start -Visit [TDesign Starter](https://tdesign.tencent.com/starter/vue/) to experience in TDesign Vue UI components. +Visit [TDesign Starter](https://tdesign.tencent.com/starter/vue/) to experience in the application built with TDesign Vue UI components. # Browser Support @@ -68,8 +67,8 @@ Read our [browser compatibility](https://github.com/Tencent/tdesign/wiki/Browser TDesign also provides component libraries for other platforms and frameworks. -- UI component library for Vue 3.x : [tdesign-vue-next](https://github.com/Tencent/tdesign-vue-next) -- UI component library for React : [tdesign-react](https://github.com/Tencent/tdesign-react) +- component library for Vue 3.x : [tdesign-vue-next](https://github.com/Tencent/tdesign-vue-next) +- component library for React : [tdesign-react](https://github.com/Tencent/tdesign-react) - component library for Wechat miniprogram : [tdesign-miniprogram](https://github.com/Tencent/tdesign-miniprogram) # License