Skip to content

Commit fd34e66

Browse files
author
Adam Plesnik
committed
Update README, v 0.0.3
1 parent e339465 commit fd34e66

File tree

2 files changed

+25
-5
lines changed

2 files changed

+25
-5
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
11
# Scroll-driven Animations for Tailwind CSS
22

3+
A plugin for Tailwind CSS v3.4+ that provides utilities for scroll-driven animations.
4+
35
`unofficial` `experimental` `chrome-115+`
46

5-
A plugin for Tailwind CSS v3.4+ that provides utilities for scroll-driven animations.
7+
## Installation
8+
9+
Install the plugin from npm:
10+
11+
```sh
12+
npm install @adam.plesnik/taiwlindcss-scroll-driven-animations
13+
```
14+
15+
Then add the plugin to your `tailwind.config.js`:
16+
17+
```js
18+
module.exports = {
19+
plugins: [
20+
require('@adam.plesnik/taiwlindcss-scroll-driven-animations'),
21+
// ...
22+
],
23+
}
24+
```
625

726
## Usage
827

package.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@adam.plesnik/taiwlindcss-scroll-driven-animations",
3-
"version": "0.0.2",
3+
"version": "0.0.3",
44
"author": "Adam Plesnik <[email protected]>",
55
"scripts": {
66
"build": "npx swc ./src/index.js --out-dir ./dist"
@@ -12,7 +12,7 @@
1212
"trailingComma": "es5"
1313
},
1414
"peerDependencies": {
15-
"tailwindcss": ">=3.2.0"
15+
"tailwindcss": ">=3.4.0"
1616
},
1717
"devDependencies": {
1818
"@swc/cli": "^0.3.10",
@@ -22,7 +22,7 @@
2222
"tailwindcss": "^0.0.0-insiders.3ba51d1",
2323
"typescript": "^5.4.3"
2424
},
25-
"description": "`unofficial` `experimental` `chrome-115+`",
25+
"description": "A plugin for Tailwind CSS v3.4+ that provides utilities for scroll-driven animations.",
2626
"files": [
2727
"dist"
2828
],
@@ -36,7 +36,8 @@
3636
"scroll",
3737
"driven",
3838
"animations",
39-
"css"
39+
"css",
40+
"tailwind"
4041
],
4142
"license": "MIT",
4243
"bugs": {

0 commit comments

Comments
 (0)