Skip to content

Commit efebca9

Browse files
committed
Update readme
1 parent 7d3e20b commit efebca9

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
### 🚀 [Demo](http://michalsnik.github.io/aos/)
1515

1616
### 🌟 Codepen Examples
17-
- [Different build in animations](http://codepen.io/michalsnik/pen/WxNdvq)
17+
- [Different built-in animations](http://codepen.io/michalsnik/pen/WxNdvq)
1818
- [With anchor setting in use](http://codepen.io/michalsnik/pen/jrOYVO)
19-
- [With anchor-placement and different easing](http://codepen.io/michalsnik/pen/EyxoNm)
19+
- [With anchor-placement and different easings](http://codepen.io/michalsnik/pen/EyxoNm)
2020
- [With simple custom animations](http://codepen.io/michalsnik/pen/WxvNvE)
2121

2222
---
@@ -26,18 +26,18 @@
2626
Add styles in `<head>`:
2727

2828
```html
29-
<link rel="stylesheet" href="https://unpkg.com/aos/dist/aos.css" />
29+
<link rel="stylesheet" href="https://unpkg.com/aos@next/dist/aos.css" />
3030
```
3131

3232
Add script right before closing `</body>` tag:
3333
```html
34-
<script src="https://unpkg.com/aos/dist/aos.js"></script>
34+
<script src="https://unpkg.com/aos@next/dist/aos.js"></script>
3535
```
3636

3737
You can also use:
3838

39-
* `yarn add aos`
40-
* `npm install --save aos`
39+
* `yarn add aos@next`
40+
* `npm install --save aos@next`
4141

4242
## 🤔 How to use it?
4343

@@ -117,7 +117,7 @@ By default AOS is watching for DOM changes and if there are any new elements loa
117117

118118
### JS Events
119119

120-
AOS dispatches two events on document: `aos:in` and `aos:out` whenever any element animates in our our, so that you can do extra stuff in JS:
120+
AOS dispatches two events on document: `aos:in` and `aos:out` whenever any element animates in or out, so that you can do extra stuff in JS:
121121
```js
122122
document.addEventListener('aos:in', ({ detail }) => {
123123
console.log('animated in', detail);
@@ -133,7 +133,9 @@ You can also tell AOS to trigger custom event on specific element, by setting `d
133133
<div data-aos="fade-in" data-aos-id="super-duper"></div>
134134
```
135135

136-
Then you'll be able to listen for two custom events `aos:in:super-duper` and `aos:out:super-duper`.
136+
Then you'll be able to listen for two custom events then:
137+
- `aos:in:super-duper`
138+
- `aos:out:super-duper`
137139

138140
### Recepies:
139141

0 commit comments

Comments
 (0)