Skip to content

Commit 4a9201d

Browse files
committed
docs: update README for improved clarity and structure
1 parent ae9479d commit 4a9201d

File tree

1 file changed

+45
-32
lines changed

1 file changed

+45
-32
lines changed

README.md

Lines changed: 45 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,61 @@
1-
# Vue 3 Carousel
1+
<p align="center">
2+
<img src="/docs/public/vue3-carousel-logo.svg" width="200" alt="Vue 3 Carousel Logo">
3+
</p>
4+
5+
<h1 align="center">Vue 3 Carousel</h1>
26

7+
<p align="center">
38
Modern lightweight Vue 3 carousel component
9+
</p>
410

5-
<p>
11+
<p align="center">
612
<a href="https://npm-stat.com/charts.html?package=vue3-carousel"><img src="https://img.shields.io/npm/dm/vue3-carousel.svg" alt="npm"/></a>
713
<a href="https://www.npmjs.com/package/vue3-carousel"><img src="https://img.shields.io/npm/v/vue3-carousel.svg" alt="npm"/></a>
814
<a href="https://packagequality.com/#?package=vue3-carousel"><img src="https://packagequality.com/shield/vue3-carousel.svg" alt="Package Quality"/></a>
915
</p>
1016

11-
## Documentation
12-
13-
https://vue3-carousel.ismail9k.com/
14-
15-
## Features
16-
17-
- [x] Responsive breakpoints
18-
- [x] Mouse/touch dragging
19-
- [x] Infinity scroll (wrapping around)
20-
- [x] Auto play
21-
- [x] Add classes for active and for visible slides
22-
- [x] RTL
23-
- [x] Enrich a11y
24-
- [x] Vertical Slides
25-
26-
## Nuxt Module
27-
28-
If you're using Nuxt and prefer to use it via module, please refer to [vue3-carousel-nuxt](https://github.com/gaetansenn/vue3-carousel-nuxt?tab=readme-ov-file)
17+
## ✨ Features
2918

30-
## Getting started
19+
- 📱 **Responsive** - Breakpoints support
20+
- 🔄 **Infinite Scroll** - Wrap around sliding
21+
- 🖱️ **Mouse/Touch** - Dragging support
22+
-**Auto Play** - Automatic sliding
23+
- 🎯 **Slide Classes** - Active & visible states
24+
- 🌐 **RTL** - Right-to-left support
25+
-**A11y** - Keyboard navigation & ARIA labels
26+
- 📊 **Vertical** - Vertical sliding mode
3127

32-
### Installation
33-
34-
First step is to install it using `yarn` or `npm`:
28+
## 🚀 Installation
3529

3630
```bash
37-
npm install vue3-carousel
31+
# npm
32+
npm i vue3-carousel
3833

39-
# or use yarn
34+
# yarn
4035
yarn add vue3-carousel
36+
37+
# pnpm
38+
pnpm install vue3-carousel
4139
```
4240

43-
### Basic Using
41+
## 📖 Basic Usage
4442

4543
```vue
4644
<script setup>
4745
// If you are using PurgeCSS, make sure to whitelist the carousel CSS classes
48-
import 'vue3-carousel/dist/carousel.css'
46+
import 'vue3-carousel/carousel.css'
4947
import { Carousel, Slide, Pagination, Navigation } from 'vue3-carousel'
5048
51-
const config = {
52-
itemsToShow: 1.5
49+
const carouselConfig = {
50+
itemsToShow: 2.5,
51+
wrapAround: true
5352
}
5453
</script>
5554
5655
<template>
57-
<Carousel v-bind="config">
56+
<Carousel v-bind="carouselConfig">
5857
<Slide v-for="slide in 10" :key="slide">
59-
{{ slide }}
58+
<div class="carousel__item">{{ slide }}</div>
6059
</Slide>
6160
6261
<template #addons>
@@ -66,3 +65,17 @@ const config = {
6665
</Carousel>
6766
</template>
6867
```
68+
69+
## 📚 Documentation
70+
71+
Visit our [documentation website](https://vue3-carousel.ismail9k.com/) for detailed usage and examples:
72+
73+
- [Getting Started](https://vue3-carousel.ismail9k.com/guide)
74+
- [Carousel Component](https://vue3-carousel.ismail9k.com/components/carousel)
75+
- [Slide Component](https://vue3-carousel.ismail9k.com/components/slide)
76+
- [Navigation Component](https://vue3-carousel.ismail9k.com/components/navigation)
77+
- [Pagination Component](https://vue3-carousel.ismail9k.com/components/pagination)
78+
79+
## 💚 Nuxt Module
80+
81+
For Nuxt users, check out [vue3-carousel-nuxt](https://github.com/gaetansenn/vue3-carousel-nuxt) module.

0 commit comments

Comments
 (0)