diff --git a/README.md b/README.md index c4ccfd7..4e15e14 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,56 @@ # Snap Carousel -A very lightweight (4.7kB gzip) carousel library using the css [scroll-snap](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-snap-type) feature +A very lightweight (4.7kB gzip) carousel library using the css [scroll-snap](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-snap-type) feature and the custom element shadow DOM to allow customization -Check de [demo](https://corentin-gautier.github.io/snap-carousel/) +Check de [demo](https://corentin-gautier.github.io/snap-carousel/) for examples + +## Features +- Prev/Next buttons +- Pagination +- Pager (ie: "1 of 6") +- loop (the css one, no cloning) +- autoplay with stop on hover +- Responsive configuration ## Documentation -coming soon ;) + +### How to use : Example +```html + + +``` + +### Options +TODO +| Attribute | Signification | +| ------------- | ------------- | +| vertical | ... | +| displayed | ... | +| per-page | ... | +| nav | ... | +| controls | ... | +| pager | ... | +| stop | ... | +| gap | ... | +| padding | ... | +| behaviour | ... | +| loop | ... | +| autoplay | ... | +| use-pause | ... | +| responsive | ... | + +## Customize the controls +TODO