Skip to content

Commit d3c101e

Browse files
committed
docs: update README
1 parent d49a510 commit d3c101e

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

Diff for: README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@
33
一个简单、灵活的`Vue3`走马灯组件,非常轻量,只有`5kB`
44

55
预览地址:
6-
[https://kagol.gitee.io/vue-carousel/](https://kagol.gitee.io/vue-carousel/)
6+
[https://kagol.github.io/vue-carousel/](https://kagol.github.io/vue-carousel/)
77

88
## 快速开始
99

1010
创建一个vite工程:
1111

1212
```
13-
yarn create vite vite-demo --template vue-ts
13+
npm create vite vite-demo --template vue-ts
1414
```
1515

1616
安装`Carousel`
1717
```
18-
yarn add @kagol/vue-carousel
18+
npm install @kagol/vue-carousel
1919
```
2020

2121
`main.ts`中引入`Carousel`
@@ -31,11 +31,11 @@ createApp(App)
3131
`App.vue`中使用:
3232

3333
```
34-
<DCarousel>
34+
<Carousel>
3535
<div class="carousel-item">page 1</div>
3636
<div class="carousel-item">page 2</div>
3737
<div class="carousel-item">page 3</div>
38-
</DCarousel>
38+
</Carousel>
3939
```
4040

4141
## 效果动图
@@ -82,7 +82,7 @@ B站:
8282

8383
## API
8484

85-
### DCarousel 组件
85+
### Carousel 组件
8686

8787
props
8888

@@ -100,7 +100,7 @@ props
100100
| indicator | -- | -- | 可选,指示器插槽 |
101101
| pagination | -- | -- | 可选,分页器插槽 |
102102

103-
### DCarouselIndicator 组件
103+
### CarouselIndicator 组件
104104

105105
props
106106

@@ -115,15 +115,15 @@ props
115115
| ------- | ------ | ---- | -------------- |
116116
| default | ({ pageIndex, setPageIndex }) => {} | -- | 可选,默认插槽 |
117117

118-
### DCarouselPrev 组件
118+
### CarouselPrev 组件
119119

120120
插槽
121121

122122
| 属性 | 类型 | 默认 | 说明 |
123123
| ------- | ------ | ---- | -------------- |
124124
| default | -- | -- | 可选,默认插槽 |
125125

126-
### DCarouselNext 组件
126+
### CarouselNext 组件
127127

128128
插槽
129129

Diff for: package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"name": "@kagol/vue-carousel",
3-
"version": "0.0.1",
4-
"description": "Vue3 Carousel",
5-
"homepage": "https://kagol.gitee.io/vue-carousel/",
3+
"version": "0.1.0",
4+
"description": "Vue3 Carousel: A simple and flexible carousel component for Vue3, extremely lightweight with only 5kB.",
5+
"homepage": "https://kagol.github.io/vue-carousel/",
66
"files": [
77
"dist"
88
],

0 commit comments

Comments
 (0)