diff --git a/README.md b/README.md index b4802b5..797a93b 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ DOM-first, responsive carousel for React. -React Snap Carousel leaves the DOM in charge of scroll state and merely computes derived data from the layout, allowing you to progressively enhance a scroll element with responsive carousel controls. +React Snap Carousel leaves the DOM in charge of scrolling and simply computes derived state from the layout, allowing you to progressively enhance a scroll element with responsive carousel controls. 🧈 Utilizes native browser scrolling & CSS scroll snap points @@ -22,6 +22,8 @@ React Snap Carousel leaves the DOM in charge of scroll state and merely computes 🔥[LIVE DEMO](https://richardscarrott.github.io/react-snap-carousel/)🔥 +## Usage + ### Basic This basic carousel will dynamically add CSS snap points to items based on the current DOM layout. @@ -65,9 +67,9 @@ const BasicCarousel = () => { export default BasicCarousel; ``` -### Advanced +### Controls -This advanced example will additionally render dynamic carousel controls. +This controls example additionally renders dynamic carousel controls. ```tsx import React from 'react'; @@ -127,3 +129,7 @@ const AdvancedCarousel = () => { export default AdvancedCarousel; ``` + +## License + +[MIT](LICENSE) diff --git a/react-snap-carousel.gif b/react-snap-carousel.gif new file mode 100644 index 0000000..24625f8 Binary files /dev/null and b/react-snap-carousel.gif differ