Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
David Sancho committed May 27, 2016
1 parent 348067f commit 9abcd0e
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,10 @@

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/) [![npm](https://img.shields.io/npm/dm/localeval.svg)](https://www.npmjs.com/package/scrollto-with-animation)

- Only **one dependency** *(for the [polyfill](https://www.npmjs.com/package/animation-frame))*
- **Cross-browser**
- Only **one dependency** *(for the [polyfill](https://www.npmjs.com/package/animation-frame))* for **rAF cross-browser**
- **60 FPS** Animation
- If user scrolls while animation is running, scroll animation would be immediately canceled
- Available adding **script or browserify**
- Available adding **script or module**

#### [Live demo](https://davesnx.github.io/scrollto-with-animation/docs/demo/index.html)

Expand All @@ -18,15 +17,15 @@ npm install scrollto-with-animation --save

## Usage

### Available with browserify
### Available as a module

```javascript
var scrollToWithAnimation = require('scrollto-with-animation')
// or ES2015
import scrollToWithAnimation from 'scrollto-with-animation'
```

### or available as a script
### or as a script

```html
<script src="scrollToWithAnimation.min.js"></script>
Expand Down

0 comments on commit 9abcd0e

Please sign in to comment.