Skip to content

Commit b26f906

Browse files
committed
docs: 完善README文档
1 parent 0ef814b commit b26f906

File tree

2 files changed

+30
-3
lines changed

2 files changed

+30
-3
lines changed

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,34 @@
11
# Vue DevUI Carousel
22

3-
一个简单、灵活的`Vue3`走马灯组件,非常轻量,只有`3.9kB`
3+
一个简单、灵活的`Vue3`走马灯组件,非常轻量,只有`5kB`
44

5-
## 基本用法
5+
预览地址:
6+
[https://kagol.gitee.io/vue-carousel/](https://kagol.gitee.io/vue-carousel/)
7+
8+
## 快速开始
9+
10+
创建一个vite工程:
11+
12+
```
13+
yarn create vite vite-demo --template vue-ts
14+
```
15+
16+
安装`Carousel`
17+
```
18+
yarn add vue-devui-carousel
19+
```
20+
21+
`main.ts`中引入`Carousel`
22+
```
23+
import Carousel from 'vue-devui-carousel'
24+
import 'vue-devui-carousel/dist/style.css'
25+
26+
createApp(App)
27+
.use(Carousel)
28+
.mount('#app')
29+
```
30+
31+
`App.vue`中使用:
632

733
```
834
<DCarousel>

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
22
"name": "vue-devui-carousel",
3-
"version": "0.0.11",
3+
"version": "0.1.0",
44
"description": "Vue3 Carousel",
5+
"homepage": "https://kagol.gitee.io/vue-carousel/",
56
"files": ["dist"],
67
"main": "./dist/vue-carousel.umd.js",
78
"module": "./dist/vue-carousel.es.js",

0 commit comments

Comments
 (0)