Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Michał Sajnóg committed Jun 14, 2016
1 parent 5bac1ad commit bde7103
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,22 @@ If you scroll back to top, element will animate to it's previous state and is re

## Setup

You can download AOS [directly](https://github.com/michalsnik/aos/archive/master.zip), but I recommend you to use `bower`:
### Install AOS

- Using `bower`

```bash
bower install aos --save
```

- Using `npm`

```bash
npm install aos --save
```

- Direct download -> [click here](https://github.com/michalsnik/aos/archive/master.zip)

```bash
bower install aos --save
```

### Link styles

Expand All @@ -35,6 +46,8 @@ You can download AOS [directly](https://github.com/michalsnik/aos/archive/master
<script src="bower_components/aos/dist/aos.js"></script>
```

AOS from version `1.2.0` is available as UMD module, so you can use it as AMD, Global, Node or ES6 module.

### Init AOS

```javascript
Expand Down

0 comments on commit bde7103

Please sign in to comment.