Skip to content

Commit 93add6c

Browse files
authored
update readme
- add installation notes for NPM and Yarn. - add note about Bower's current development state - update JQuery version
1 parent 9ed1680 commit 93add6c

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,32 @@ Simple parallax scrolling effect inspired by [Spotify.com](http://spotify.com/)
66

77
## Installation
88

9-
Download package or install with Bower and include `parallax.min.js` in your document after including jQuery.
9+
### NPM
10+
11+
```bash
12+
npm i --save jquery-parallax.js
13+
```
14+
15+
### Yarn
16+
17+
```bash
18+
yarn add jquery-parallax.js
19+
```
20+
21+
### Bower
22+
23+
Please note that although Bower is still maintained, they recommend Yarn for new projects.
1024

1125
```bash
1226
$ bower i --save parallax.js
1327
```
1428

29+
### Setup
30+
31+
Include `parallax.min.js` in your document after including jQuery.
32+
1533
```html
16-
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
34+
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
1735
<script src="/path/to/parallax.min.js"></script>
1836
```
1937

0 commit comments

Comments
 (0)