Skip to content

Commit

Permalink
chore: add README in English
Browse files Browse the repository at this point in the history
  • Loading branch information
uyarn committed Nov 3, 2022
1 parent fa2e6e0 commit e5864bc
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 12 deletions.
13 changes: 9 additions & 4 deletions README_zh-CN.md → README-zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@
</a>
</p>

TDesign 适配桌面端的组件库,适合在 vue 2.x 技术栈项目中使用。
简体中文 | [English](./README.md)

TDesign 适配桌面端的组件库,适合在 Vue 2.x 技术栈项目中使用。

# 🎉 特性

Expand All @@ -29,15 +31,14 @@ TDesign 适配桌面端的组件库,适合在 vue 2.x 技术栈项目中使用
- 支持暗黑模式及其他主题定制
- 支持按需加载

# 安装
# 📦 安装

```shell
npm i tdesign-vue
```

# 基础使用
# 🔨 基础使用

推荐使用 Webpack 或 Rollup 等支持 tree-shaking 特性的构建工具,无需额外配置即可实现组件按需引入:

```js
import Vue from 'vue';
Expand Down Expand Up @@ -69,6 +70,10 @@ npm package 中提供了多种构建产物,可以阅读 [这里](https://githu
- 桌面端 React 实现: [web-react](https://github.com/Tencent/tdesign-react)
- 移动端小程序实现: [小程序](https://github.com/Tencent/tdesign-miniprogram)

# 参与贡献

TDesign 欢迎任何愿意参与贡献的参与者。如果需要本地运行代码或参与贡献,请先阅读[参与贡献](https://github.com/Tencent/tdesign-vue/blob/develop/CONTRIBUTING.md)

# 开源协议

TDesign 遵循 [MIT 协议](https://github.com/Tencent/tdesign-vue/blob/main/LICENSE)
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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);
Expand All @@ -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

Expand All @@ -68,10 +67,14 @@ 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)

# Contributing

Contributing is welcome. Read [guidelines for contributing](https://github.com/Tencent/tdesign-vue/blob/develop/CONTRIBUTING.md) before submitting your [Pull Request](https://github.com/Tencent/tdesign-vue/pulls).

# License

The MIT License. Please see [the license file](./LICENSE) for more information.

0 comments on commit e5864bc

Please sign in to comment.