Update README, add LICENSE

Author: Adam Plesnik

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Adam Plesnik adamplesnik.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,4 +1,34 @@
-# Scrol-driven Animations in Tailwind CSS
-`experimental` `unofficial`
+# Scroll-driven Animations for Tailwind CSS
 
-A plugin for Tailwind CSS v3.2+ that provides utilities for scroll-driven-animations.
+`unofficial` `experimental` `chrome-115+`
+
+A plugin for Tailwind CSS v3.4+ that provides utilities for scroll-driven animations.
+
+## Usage
+
+The plugin provides utilities for a subset of CSS scroll-driven animation properties.
+
+- `animation-timeline`
+- `animation-range-start`, `animation-range-end`
+- `scroll-timeline`, `view-timeline`
+- `timeline-scope`
+
+### Animation Timeline
+
+The single most impressive feature of scroll-driven animations is an anonymous animation timeline. It allows user to easily trigger anything just by scrolling the page. The plugin allows user to use the `.timeline` CSS class which defaults to `animation-timeline: scroll(y)` and also provides an option to set custom timeline name with a modifier.
+
+### Scroll and View Timeline
+
+Scroll and View timelines provide user with better control over the animations. Both `.scroll-timeline` and `.view-timeline` are meant to be used with modifiers to set the timeline name.
+
+### Range
+
+Animation range controls start and end of an animation. Utility classes `.range-start` and `.range-end` can be used for setting the start and the end of the range. They default to `entry` and `exit` respectively.
+
+### Scope
+
+Timeline scope allows to control animated elements outside the parent which defines the timeline. Utility `.scope` should be used with a modifier to define the timeline name set by `.scroll-timeline` or `.view-timeline`.
+
+### Browser Support
+
+Scroll-driven animations are not broadly supported yet. Use `@supports` rules for fallback styling.