Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

trans: add zh-Hans README #306

Closed
wants to merge 9 commits into from
Closed
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ Equal UI is a Vue 3 hackable components library with 30+ components on top of Ta
<a href="https://equal-ui.github.io/Equal/"><strong>Explore Equal UI docs</strong></a>
</div>

---
<a href="./README_zh-hans.md">中文简体</a>

# Features

- 🔥 One of the best visuals in Vue ecosystem
Expand Down
76 changes: 76 additions & 0 deletions README_zh-hans.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<p align="center">
<a href="https://equal-ui.github.io/Equal/">
<img width="150" src="./docs/public/logo.svg">
</a>

<p align="center">
<img src="https://img.shields.io/npm/v/equal-vue?color=blue">
<img src="https://img.shields.io/npm/l/equal-vue">
<img src="https://img.shields.io/npm/dw/equal-vue">
<img src="https://img.badgesize.io/https:/unpkg.com/equal-vue/?label=Brotli%20size%3A%20JS&compression=brotli">
</p>
</p>

<h1 align="center">
Equal UI
</h2>

<div align="center">
Equal UI 是一个 Vue 3 可拆解的组件库,在 Tailwindcss 之上包含 30+ 个组件
<br>
<a href="https://equal-ui.github.io/Equal/"><strong>探索 Equal UI 文档</strong></a>
</div>

# 特征

- 🔥 Vue 生态系统中最好的视觉效果之一
- 🌃 内置深色主题
- 🎨 完全定制
- 💬 有工具提示、通知、弹出框
- 👌 轻量级:12KB brotli
- 🔧 包括 30+ 组件
- 💅 使用你的顺风类

# 链接

<b> Twitter: </b> [@Yan](https://twitter.com/k0mmsussertod)

# 安装

你需要 [Vue.js](https://v3.vuejs.org/) 版本 3.1+

```bash
# npm
npm install equal-vue
```

```bash
# yarn
yarn add equal-vue
```

# 用法

## 所有组件

```js
import { createApp } from 'vue'
import Equal from 'equal-vue'
import Config from 'equal-vue/dist/theme/full' // or light / dark theme

createApp.use(Equal, Config)
```

## 或单个组件

```js
import { createApp } from 'vue'
import { Button, Switch } from 'equal-vue'
import Config from 'equal-vue/dist/theme/full' // or light / dark theme

createApp.use(Button, Config).use(Switch, Config)
```

# 许可证

[MIT](https://raw.githubusercontent.com/Equal-UI/Equal/master/LICENSE)
Loading