# NumScroll

## Digital scrolling animation plugin

### Install
```bash
npm i jq-numscroll -s
```

### Dependencies
1. jQuery

### How to Require

You need to require/include Your file in the layout or the global application script     

- CommonJS  

```js
require('jq-numscroll/src/js/core')
```
    
- HTML (include before `</body>`)

```js
<script src='http://code.jquery.com/jquery-2.1.1.min.js' type='text/javascript'></script>
<script src="js/core.js" type="text/javascript" charset="utf-8"></script>
```

### Example of Usage
```html
<!-- Put the numbers inside the element with the num class -->
<span class="num">888888</span>

<!-- Or, put the numbers inside the data-num attribute -->
<span class="num" data-num="888888"></span>
```

### Initializing
```js
$(".num").numScroll();
```

### API Options
Option    |  Default Value | Description
--        |    --          | --
time      |   1500         | Total time of the animation
delay     |   0            | Delay time, before animation starts

### Example
![Demo](./static/index.gif)