Skip to content
This repository was archived by the owner on Jan 8, 2025. It is now read-only.

Commit 917e85b

Browse files
haoziqaqhaoziqaq
committed
chore: fix readme
1 parent 5e3a7b9 commit 917e85b

File tree

4 files changed

+209
-22
lines changed

4 files changed

+209
-22
lines changed

‎README.md‎

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@
33
<img src="https://varlet.gitee.io/varlet-ui-vue2/logo.svg" width="150">
44
</a>
55
<h1>VARLET-VUE2</h1>
6-
<p>基于 Vue2 的 Material design 风格移动端组件库</p>
7-
<p>
8-
<a href="https://varlet.gitee.io/varlet-ui-vue2/">开发文档</a> | <a href="https://github.com/varletjs/varlet-vue2/blob/dev/README.en-US.md">English</a>
6+
<p>Material design mobile component library for Vue2</p>
7+
<p>
8+
<a href="https://varlet-vue2.vercel.app/#/en-US/index">Documentation(Vercel)</a> |
9+
<a href="https://varlet.gitee.io/varlet-ui-vue2/#/en-US/index">Documentation(Gitee)</a> |
10+
<a href="https://github.com/varletjs/varlet-vue2/blob/dev/README.zh-CN.md">中文README</a>
911
</p>
1012
<p>
1113
<img src="https://img.shields.io/npm/v/@varlet-vue2/ui?style=flat-square" alt="version">
@@ -20,27 +22,28 @@
2022

2123
---
2224

23-
### 介绍
25+
### Intro
26+
27+
Varlet-vue2 is a Material design mobile component library developed based on `Vue2`, developed and maintained by partners in the community.
2428

25-
`Varlet-vue2` 是 `Varlet` 的 vue2 版本, 是一个 Material 风格移动端组件库，由社区建立起来的组件库团队进行维护。
2629

27-
### 特性
28-
- 🚀 提供50个高质量通用组件
29-
- 🚀 组件十分轻量
30-
- 💪 由国人开发，完善的中英文文档和后勤保障
31-
- 🛠️ 支持按需引入
32-
- 🛠️ 支持主题定制
33-
- 🌍 支持国际化
34-
- 💡 支持 webstorm，vscode 组件属性高亮
35-
- 💪 支持 SSR
36-
- 💡 支持 Typescript
37-
- 💪 确保90%以上单元测试覆盖率，提供稳定性保证
38-
- 🛠️ 支持暗黑模式
30+
### Features
31+
- 🚀 Provide 50 high quality general purpose components
32+
- 🚀 Components are very lightweight
33+
- 💪 Developed by Chinese, complete Chinese and English documentation and logistics support
34+
- 🛠️ Support on-demand introduction
35+
- 🛠️ Support theme customization
36+
- 🌍 Support internationalization
37+
- 💡 Support WebStorm, VS Code component syntax highlighting
38+
- 💪 Support the SSR
39+
- 💡 Support the Typescript
40+
- 💪 Make sure more than 90 percent unit test coverage, providing stability assurance
41+
- 🛠️ Support dark mode
3942

40-
### 安装
43+
### Install
4144

4245
### CDN
43-
`varlet.js` 包含组件库的所有样式和逻辑，引入即可。
46+
`varlet.js` component functions have been completed, and unit testing is in progress, recommended for internal testing
4447

4548
```html
4649
<div id="app"></div>
@@ -50,14 +53,16 @@
5053
Vue.use(Varlet)
5154
5255
new Vue({
53-
template: '<var-button>按钮</var-button>'
56+
template: '<var-button>Button</var-button>'
5457
}).$mount('#app')
5558
</script>
5659
```
5760

5861
### Webpack / Vite
62+
5963
```shell
60-
# 通过 npm 或 yarn 或 pnpm 安装
64+
# Install with npm or yarn or pnpm
65+
6166
# npm
6267
npm i @varlet-vue2/ui -S
6368

‎README.zh-CN.md‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
<div align="center">
2+
<a href="https://varlet.gitee.io/varlet-ui-vue2/">
3+
<img src="https://varlet.gitee.io/varlet-ui-vue2/logo.svg" width="150">
4+
</a>
5+
<h1>VARLET-VUE2</h1>
6+
<p>基于 Vue2 的 Material design 风格移动端组件库</p>
7+
<p>
8+
<a href="https://varlet-vue2.vercel.app">文档(Vercel)</a> |
9+
<a href="https://varlet.gitee.io/varlet-ui-vue2">文档(Gitee)</a> |
10+
<a href="https://github.com/varletjs/varlet/blob/dev/README.md">ENGLISH README</a>
11+
</p>
12+
<p>
13+
<img src="https://img.shields.io/npm/v/@varlet-vue2/ui?style=flat-square" alt="version">
14+
<img src="https://img.shields.io/github/stars/varletjs/varlet-vue2" alt="ci">
15+
<img src="https://img.shields.io/badge/vue-v2.6.14%2B-%23407fbc" alt="vue">
16+
<img src="https://img.shields.io/npm/l/@varlet-vue2/ui.svg" alt="licence">
17+
<img src="https://img.shields.io/codecov/c/github/varletjs/varlet-vue2" alt="coverage">
18+
<img src="https://img.badgesize.io/https://unpkg.com/@varlet-vue2/ui/umd/varlet.js?compression=gzip&label=gzip" alt="gzip" />
19+
<img src="https://github.com/varletjs/varlet-vue2/workflows/CI/badge.svg" alt="ci">
20+
</p>
21+
</div>
22+
23+
---
24+
25+
### 介绍
26+
27+
`Varlet-vue2` 是 `Varlet` 的 vue2 版本, 是一个 Material 风格移动端组件库，由社区建立起来的组件库团队进行维护。
28+
29+
### 特性
30+
- 🚀 提供50个高质量通用组件
31+
- 🚀 组件十分轻量
32+
- 💪 由国人开发，完善的中英文文档和后勤保障
33+
- 🛠️ 支持按需引入
34+
- 🛠️ 支持主题定制
35+
- 🌍 支持国际化
36+
- 💡 支持 webstorm，vscode 组件属性高亮
37+
- 💪 支持 SSR
38+
- 💡 支持 Typescript
39+
- 💪 确保90%以上单元测试覆盖率，提供稳定性保证
40+
- 🛠️ 支持暗黑模式
41+
42+
### 安装
43+
44+
### CDN
45+
`varlet.js` 包含组件库的所有样式和逻辑，引入即可。
46+
47+
```html
48+
<div id="app"></div>
49+
<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script>
50+
<script src="https://cdn.jsdelivr.net/npm/@varlet-vue2/ui/umd/varlet.js"></script>
51+
<script>
52+
Vue.use(Varlet)
53+
54+
new Vue({
55+
template: '<var-button>按钮</var-button>'
56+
}).$mount('#app')
57+
</script>
58+
```
59+
60+
### Webpack / Vite
61+
```shell
62+
# 通过 npm 或 yarn 或 pnpm 安装
63+
# npm
64+
npm i @varlet-vue2/ui -S
65+
66+
# yarn
67+
yarn add @varlet-vue2/ui
68+
69+
# pnpm
70+
pnpm add @varlet-vue2/ui
71+
```
72+
73+
```js
74+
import App from './App.vue'
75+
import Varlet from '@varlet-vue2/ui'
76+
import Vue from 'vue'
77+
import '@varlet-vue2/ui/es/style.js'
78+
79+
Vue.use(Varlet)
80+
81+
new Vue({
82+
render: (h) => h(App)
83+
}).$mount('#app')
84+
```
85+
86+
### Contributors
87+
88+
<a href="https://github.com/varletjs/varlet-vue2/graphs/contributors">
89+
<img src="https://contrib.rocks/image?repo=varletjs/varlet-vue2" />
90+
</a>

‎README.en-US.md‎ renamed to ‎packages/varlet-vue2-ui/README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
<h1>VARLET-VUE2</h1>
66
<p>Material design mobile component library for Vue2</p>
77
<p>
8-
<a href="https://varlet.gitee.io/varlet-ui-vue2/">Documentation</a>
8+
<a href="https://varlet-vue2.vercel.app/#/en-US/index">Documentation(Vercel)</a> |
9+
<a href="https://varlet.gitee.io/varlet-ui-vue2/#/en-US/index">Documentation(Gitee)</a> |
10+
<a href="https://github.com/varletjs/varlet-vue2/blob/dev/README.zh-CN.md">中文README</a>
911
</p>
1012
<p>
1113
<img src="https://img.shields.io/npm/v/@varlet-vue2/ui?style=flat-square" alt="version">

‎packages/varlet-vue2-ui/README.zh-CN.md‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
<div align="center">
2+
<a href="https://varlet.gitee.io/varlet-ui-vue2/">
3+
<img src="https://varlet.gitee.io/varlet-ui-vue2/logo.svg" width="150">
4+
</a>
5+
<h1>VARLET-VUE2</h1>
6+
<p>基于 Vue2 的 Material design 风格移动端组件库</p>
7+
<p>
8+
<a href="https://varlet-vue2.vercel.app">文档(Vercel)</a> |
9+
<a href="https://varlet.gitee.io/varlet-ui-vue2">文档(Gitee)</a> |
10+
<a href="https://github.com/varletjs/varlet/blob/dev/README.md">ENGLISH README</a>
11+
</p>
12+
<p>
13+
<img src="https://img.shields.io/npm/v/@varlet-vue2/ui?style=flat-square" alt="version">
14+
<img src="https://img.shields.io/github/stars/varletjs/varlet-vue2" alt="ci">
15+
<img src="https://img.shields.io/badge/vue-v2.6.14%2B-%23407fbc" alt="vue">
16+
<img src="https://img.shields.io/npm/l/@varlet-vue2/ui.svg" alt="licence">
17+
<img src="https://img.shields.io/codecov/c/github/varletjs/varlet-vue2" alt="coverage">
18+
<img src="https://img.badgesize.io/https://unpkg.com/@varlet-vue2/ui/umd/varlet.js?compression=gzip&label=gzip" alt="gzip" />
19+
<img src="https://github.com/varletjs/varlet-vue2/workflows/CI/badge.svg" alt="ci">
20+
</p>
21+
</div>
22+
23+
---
24+
25+
### 介绍
26+
27+
`Varlet-vue2` 是 `Varlet` 的 vue2 版本, 是一个 Material 风格移动端组件库，由社区建立起来的组件库团队进行维护。
28+
29+
### 特性
30+
- 🚀 提供50个高质量通用组件
31+
- 🚀 组件十分轻量
32+
- 💪 由国人开发，完善的中英文文档和后勤保障
33+
- 🛠️ 支持按需引入
34+
- 🛠️ 支持主题定制
35+
- 🌍 支持国际化
36+
- 💡 支持 webstorm，vscode 组件属性高亮
37+
- 💪 支持 SSR
38+
- 💡 支持 Typescript
39+
- 💪 确保90%以上单元测试覆盖率，提供稳定性保证
40+
- 🛠️ 支持暗黑模式
41+
42+
### 安装
43+
44+
### CDN
45+
`varlet.js` 包含组件库的所有样式和逻辑，引入即可。
46+
47+
```html
48+
<div id="app"></div>
49+
<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script>
50+
<script src="https://cdn.jsdelivr.net/npm/@varlet-vue2/ui/umd/varlet.js"></script>
51+
<script>
52+
Vue.use(Varlet)
53+
54+
new Vue({
55+
template: '<var-button>按钮</var-button>'
56+
}).$mount('#app')
57+
</script>
58+
```
59+
60+
### Webpack / Vite
61+
```shell
62+
# 通过 npm 或 yarn 或 pnpm 安装
63+
# npm
64+
npm i @varlet-vue2/ui -S
65+
66+
# yarn
67+
yarn add @varlet-vue2/ui
68+
69+
# pnpm
70+
pnpm add @varlet-vue2/ui
71+
```
72+
73+
```js
74+
import App from './App.vue'
75+
import Varlet from '@varlet-vue2/ui'
76+
import Vue from 'vue'
77+
import '@varlet-vue2/ui/es/style.js'
78+
79+
Vue.use(Varlet)
80+
81+
new Vue({
82+
render: (h) => h(App)
83+
}).$mount('#app')
84+
```
85+
86+
### Contributors
87+
88+
<a href="https://github.com/varletjs/varlet-vue2/graphs/contributors">
89+
<img src="https://contrib.rocks/image?repo=varletjs/varlet-vue2" />
90+
</a>

0 commit comments

Comments
 (0)