Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bfintal committed Nov 26, 2013
1 parent fef978b commit 20207e2
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ Counter-Up is a jQuery plugin that *animates* a number from zero (counting up to
* floats `0.1234`
* formatted numbers `1,234,567.00`

Features:

* Auto-detect for integers, floats or formatted numbers
* The plugin will also use the number of decimal places the original number is using.
* Lightweight: ~1kb
* Minimal setup

*Requires [waypoints.js](http://imakewebthings.com/jquery-waypoints/)*

Demo
Expand All @@ -28,6 +35,8 @@ Usage

```
<span class="counter">1,234,567.00</span>
<span>$</span><span class="counter">1.99</span>
<span class="counter">12345</span>
```

**jQuery**
Expand All @@ -36,7 +45,7 @@ Usage
$('.counter').counterUp();
```

**Extra parameters**
**or with extra parameters**

```
$('.counter').counterUp({
Expand All @@ -45,6 +54,10 @@ $('.counter').counterUp({
});
```

`delay` - The delay in milliseconds per number count up

`time` - The total duration of the count up animation

Social Stuff
============

Expand Down

0 comments on commit 20207e2

Please sign in to comment.