Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
asvd committed Apr 14, 2015
1 parent d985fa0 commit 2babfb8
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,32 +24,30 @@ scrolled):
[viewport.js](https://github.com/asvd/viewport) library


`natural scroll` has flexible FPS. Which means that animation frames
are rendered as frequent as possible. But if a system is too slow (or
a web-page is too overdesigned), `natural scroll` will simply skip
some of the frames, preserving the total time of animation. Thus the
destination scrolling position will be reached on time and users will
not have to wait any longer. Of course on faster systems the animation
is more fluent.
`natural scroll` has flexible FPS. Which means animation frames are
rendered as frequent as possible. But if a system is too slow (or a
web-page is too overdesigned), `natural scroll` skips some of the
frames, preserving the total time of animation. Thus the destination
scrolling position is reached on time and users do not have to wait
any longer. Of course on faster systems the animation is more fluent.

`natural scroll` does not have any dependencies, it is written in
vanilla javascript which means it works anywhere. And it *only costs
752 bytes* of minified code including UMD-headers!
752 bytes* of minified code including the UMD-headers!


### Usage

Download the
Using `natural scroll` is very simple. Download the
[distribution](https://github.com/asvd/naturalScroll/releases/download/v0.2.0/naturalScroll-0.2.0.tar.gz),
unpack it and load the `naturalScroll.js` in a preferable way (that is
an UMD module):
unpack it and load the `naturalScroll.js` in a preferable way:

```html
<script src="naturalScroll.js"></script>
```


Invoke the provided methods to scroll a viewport to the desired
Invoke the following methods to scroll a viewport to the desired
position:

```js
Expand Down

0 comments on commit 2babfb8

Please sign in to comment.