更新 README.md

This commit is contained in:
就眠儀式 2022-02-10 23:48:21 +08:00
parent 5f27fa6695
commit ccc36f0710
2 changed files with 54 additions and 66 deletions

View File

@ -7,6 +7,8 @@
<a href="https://coveralls.io/r/sentsin/layui?branch=master"><img alt="Test Coverage" src="https://img.shields.io/coveralls/sentsin/layui/master.svg"></a> <a href="https://coveralls.io/r/sentsin/layui?branch=master"><img alt="Test Coverage" src="https://img.shields.io/coveralls/sentsin/layui/master.svg"></a>
</p> </p>
**[🔶 Reading Document](http://layui-vue.pearadmin.com)**
An enterprise-class UI components based on Layui and Vue. An enterprise-class UI components based on Layui and Vue.
**Run with code Sandbox.** **Run with code Sandbox.**

114
README.md
View File

@ -1,89 +1,75 @@
<p align="center"> ## Introduction
<a href="http://www.layui.com">
<img src="https://images.gitee.com/uploads/images/2022/0104/135039_3f41c467_4835367.png" alt="layui" width="360">
</a>
</p>
<p align="center"> <p>
A component library for Vue 3 base on layui
</p>
<p align="center">
基 于 vue 3.0 的 组 件 库 桌 面 级 , layui 的 另 一 种 呈 现 方 式
</p>
<p align="center">
<a href="https://www.npmjs.com/package/@layui/layui-vue"><img src="https://img.shields.io/npm/v/@layui/layui-vue.svg?sanitize=true" alt="Version"></a> <a href="https://www.npmjs.com/package/@layui/layui-vue"><img src="https://img.shields.io/npm/v/@layui/layui-vue.svg?sanitize=true" alt="Version"></a>
<a href="https://www.npmjs.com/package/layui"><img src="https://img.shields.io/npm/l/layui.svg?sanitize=true" alt="License"></a> <a href="https://www.npmjs.com/package/@layui/layui-vue"><img src="https://img.shields.io/npm/l/@layui/layui-vue.svg?sanitize=true" alt="License"></a>
<a href="https://travis-ci.org/sentsin/layui"><img alt="Build Status" src="https://img.shields.io/travis/sentsin/layui/master.svg"></a> <a href="https://travis-ci.org/sentsin/layui"><img alt="Build Status" src="https://img.shields.io/travis/sentsin/layui/master.svg"></a>
<a href="https://coveralls.io/r/sentsin/layui?branch=master"><img alt="Test Coverage" src="https://img.shields.io/coveralls/sentsin/layui/master.svg"></a> <a href="https://coveralls.io/r/sentsin/layui?branch=master"><img alt="Test Coverage" src="https://img.shields.io/coveralls/sentsin/layui/master.svg"></a>
<!--<a href="https://saucelabs.com/beta/builds/7e6196205e4f492496203388fc003b65"><img src="https://saucelabs.com/buildstatus/layui" alt="Build Status"></a>-->
</p> </p>
<!-- **[🔶 Reading Document](http://layui-vue.pearadmin.com)**
<p align="center">
<a href="https://saucelabs.com/beta/builds/7e6196205e4f492496203388fc003b65"><img src="https://saucelabs.com/browser-matrix/layui.svg" alt="Browser Matrix"></a>
</p>
-->
--- An enterprise-class UI components based on Layui and Vue.
### 快速上手 : Beta **Run with code Sandbox.**
获得 layui-vue 你只需要使用 npm 引入 : [![Edit layui-vue](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/11mvy)
## Features
A few of the things you can do with layui vue:
* Writing components using setup script
* Provide Axure design resources
* Support theme customization
* Support internationalization
* Use typescript to provide complete type definition
## Get Started
Use npm to install.
```bash
npm i @layui/layui-vue
```
We have several examples on the [website](http://layui-vue.pearadmin.com). Here is the first one to get you started:
``` ```
npm install @layui/layui-vue
```
在 main.ts 中:
```js
import { createApp } from 'vue'
import Layui from '@layui/layui-vue'
import '@layui/layui-vue/lib/index.css'
import App from './App.vue'
createApp(App).use(Layui).mount('#app')
```
接下来,你就可以使用 layui-vue 来开发你的应用 :
```html
<template> <template>
<lay-layout> <lay-button-container>
<lay-header> <lay-button>Hello Word</lay-button>
<lay-logo>Layui Admin</lay-logo> </lay-button-container>
</lay-header>
<lay-side></lay-side>
<lay-body>
<router-view></router-view>
</lay-body>
<lay-footer>pearadmin.com</lay-footer>
</lay-layout>
</template> </template>
``` ```
## [阅读文档](http://layui-vue.pearadmin.com/) ## Feedback
从现在开始,用另一种方式拥抱 layui, 继续化作你方寸屏幕前的亿万字节! Feel free to send us feedback on [file an issue](https://github.com/layui-vue/layui-vue/issues/new). Feature requests are always welcome. If you wish to contribute, please take a quick look at the [guidelines](./CONTRIBUTING.md)!
### 使用趋势 If there's anything you'd like to chat about, please feel free to join our [Gitter chat](https://gitter.im/layui-vue/community)!
[![Giteye chart](https://chart.giteye.net/gitee/layui-vue/layui-vue/5ZQ67WWS.png)](https://giteye.net/chart/5ZQ67WWS) ## Contributors
### 贡献代码 This project follows the [all-contributors](https://github.com/layui-vue/layui-vue/graphs/contributors) specification and is brought to you by these [awesome contributors](https://github.com/layui-vue/layui-vue/graphs/contributors).
> 在人的尺度里,世界既无始也无终,唯一的信仰是,总有人认得你站在暴风雪里的样子。 <a href="https://github.com/layui-vue/layui-vue/graphs/contributors">
<img src="https://contrib.rocks/image?repo=layui-vue/layui-vue" />
</a>
[![Giteye chart](https://chart.giteye.net/gitee/layui-vue/layui-vue/DBC9Z6HQ.png)](https://giteye.net/chart/DBC9Z6HQ) ## Build Process
## 交流群 - `build` Packaged component library
| QQ | 微信 | Please take a look at the [contributing guidelines](./CONTRIBUTING.md) for a detailed process on how to build your application as well as troubleshooting information.
|----|----|
| <img src="https://images.gitee.com/uploads/images/2021/1008/090410_8b349271_4835367.png" width="180px" /> |<img src="wechat_qrcode/wechat_qrcode.png" width="180px" /> |
## 相关 ## Backers
[官网](http://layui-vue.pearadmin.com/)、[更新日志](http://layui-vue.pearadmin.com/zh-CN/guide/changelog)、[交流群](https://jq.qq.com/?_wv=1027&k=ffiUQgnE) Thank you to all our backers! 🙏 [[Become a backers](https://opencollective.com/layui-vue#backer)]
## Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/layui-vue#sponsor)]
## Open Source Licence
Layui vue is licensed under the [MIT license](https://opensource.org/licenses/MIT).