Skip to content

Commit 13084f8

Browse files
committed
docs: update README with npm install and cssanimation integration
1 parent 0518d40 commit 13084f8

File tree

1 file changed

+7
-18
lines changed

1 file changed

+7
-18
lines changed

README.md

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,17 @@
1-
# ScrollyJS
1+
# ScrollyJS
22

33
**ScrollyJS** is a lightweight, zero-dependency JavaScript library for triggering CSS animations when elements enter the viewport — on scroll, hover, click, or custom triggers.
44

5-
- 🎯 Zero config for default scroll-based animation
6-
- ⚙️ Custom triggers like `mouseenter`, `click`, and more
7-
- 🔬 Built with IntersectionObserver
8-
- 🪶 Lightweight and fast
9-
- 🔧 Easily extendable
5+
- Zero config for default scroll-based animation
6+
- Custom triggers like `mouseenter`, `click`, and more
7+
- Built with IntersectionObserver
8+
- Lightweight and fast
9+
- Easily extendable
1010

1111
You can create a rich and **storytelling animated web pages** with up and down scrolling 👋
1212
Visitors can feel the page with scrolling and it has a really minimal learning curve.
1313

14-
`Scrolly.js` plugin is proudly created and maintained by [cssanimation.io](http://cssanimation.io/) team, that a web based open source animation library by a team of **passionate web animation lover**.
15-
16-
We developed the most easier way to work with scroll animation, Just use `data-scrolly-top` and `data-scrolly-down` attribute to quickly build powerful templates of your own.
17-
18-
## 📦 Installation
14+
## Installation
1915

2016
### Using npm
2117

@@ -284,13 +280,6 @@ Unlike those two follow the instruction below to animate targeted contents while
284280
data-scrolly-target-click="rotateInLeft">
285281
I am animate your target object when you mouse out from me
286282
</div>
287-
288-
<script type="text/javascript" src="scrolly/scrolly.js"></script>
289-
<script>
290-
window.onload = function () {
291-
scrolly();
292-
};
293-
</script>
294283
```
295284

296285
# Advanced Settings

0 commit comments

Comments
 (0)