docs: ✏️ 更新README

This commit is contained in:
xuqingkai 2023-07-22 18:30:15 +08:00
parent 91196303cd
commit 1e359f79aa
2 changed files with 37 additions and 69 deletions

View File

@ -1,36 +0,0 @@
# wot-design-uni
#### Description
uni-app版本的wot-design-uni组件库
#### Software Architecture
Software architecture description
#### Installation
1. xxxx
2. xxxx
3. xxxx
#### Instructions
1. xxxx
2. xxxx
3. xxxx
#### Contribution
1. Fork the repository
2. Create Feat_xxx branch
3. Commit your code
4. Create Pull Request
#### Gitee Feature
1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md
2. Gitee blog [blog.gitee.com](https://blog.gitee.com)
3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore)
4. The most valuable open source project [GVP](https://gitee.com/gvp)
5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help)
6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)

View File

@ -1,37 +1,41 @@
# wot-design-uni
# Wot Design Uni
#### 介绍
uni-app版本的wot-design-uni组件库
Wot Design Uni是一个基于Wot-design开发的uni-app组件库
#### 软件架构
软件架构说明
[文档](https://wot-design-uni.netlify.app/)
# 部署状态
[![Netlify Status](https://api.netlify.com/api/v1/badges/0991d8a9-0fb0-483b-8961-5bde066bbd50/deploy-status)](https://app.netlify.com/sites/wot-design-uni/deploys)
## 安装
```bash
yarn add wot-design-uni
```
## 快速上手
```javascript
import Vue from 'vue'
import WotDesign from 'wot-design'
Vue.use(WotDesign)
// or
import {
Button,
Swipe
} from 'wot-design'
Vue.use(Button)
Vue.use(Swipe)
```
详细说明见 [快速上手](https://wot-design-uni.netlify.app/#/components/quickUse) in our documentation.
## LICENSE
[MIT](https://github.com/Moonofweisheng/wot-design-uni/blob/develop/LICENSE)
#### 安装教程
1. xxxx
2. xxxx
3. xxxx
#### 使用说明
1. xxxx
2. xxxx
3. xxxx
#### 参与贡献
1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request
#### 特技
1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md
2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目
5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)