diff --git a/README.md b/README.md index 1f311f4..4def07a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,62 @@ # Snappy-Carousel +Snappy is yet another carousel library. +Its goal is to be as lightweight and performant as possible. +It does not implement every feature found in other carousel libraries. Instead, it relies on native CSS scroll snapping and adds as little on top as possible. + +Mouse-drag behavior closely follows native touch scrolling in the browser, including inertia and snapping to a slide. + +| File | Size | +| ---------- | ------: | +| snappy.js | 6,17 kB | +| snappy.css | 1,11 kB | + + +## Usage + +### CSS only + +You can use Snappy without JavaScript. This gives you a simple CSS-only scroll container with snapping slides. + +```html + + + + +