Skip to content

Commit b1a3a37

Browse files
committed
Updated README.md
1 parent 2288042 commit b1a3a37

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,20 @@
22

33
A simple runner/stopwatch jQuery plugin for counting time up and down.
44

5+
### Project Status
6+
7+
[![Dependency Status](https://david-dm.org/jylauril/jquery-runner.png)](https://david-dm.org/jylauril/jquery-runner) [![devDependency Status](https://david-dm.org/jylauril/jquery-runner/dev-status.png)](https://david-dm.org/jylauril/jquery-runner#info=devDependencies) [![Build Status](https://travis-ci.org/jylauril/jquery-runner.png?branch=master)](https://travis-ci.org/jylauril/jquery-runner)
8+
59
## Installation
610

11+
Grab the latest version from the build/ folder.
12+
13+
There's several different versions of the file, but you only need one.
14+
15+
* In case you want to develop against the Runner, you can pick the non-minified version `jquery.runner.js`.
16+
* If you want to deploy Runner with your site/app, pick either `jquery.runner-min.js`.
17+
* Or if you develop with CoffeeScript and really want to know what's happening there, grab the `jquery.runner.coffee`. (Disclaimer: no support provided for the CoffeeScript file. If you don't know what it is, don't use it.)
18+
719
Include script *after* the jQuery library:
820

921
```html
@@ -128,8 +140,6 @@ You can alter the behavior by passing options object to the initialization.
128140

129141
* `format` - (function) A custom format function to replace the default time formatting. By default this is not set. Takes in two arguments: first one is the current time value in milliseconds, second one is the settings object. This function should return a string or a number.
130142

131-
* `interval` - (integer) Time in milliseconds how often we update the current time. Defaults to 20ms. **Note that if you use the `stopAt` option, the accuracy of the stop time will be affected by this. Also note that it is not recommended to use this option, unless you know what you're doing.**
132-
133143

134144
## Events
135145

@@ -176,12 +186,9 @@ $('#runner').runner({
176186
countdown: true,
177187
startAt: 30000,
178188
milliseconds: false,
179-
interval: 1000
180189
});
181190
```
182191

183-
*Note that the `interval` option is only set to demonstrate the possibility to change this value. In this example, it is not really needed to alter the interval, however, if you have dozens of runners like this on one page, it might be wise to make the update interval a bit slower so that it won't eat up all the CPU.*
184-
185192

186193
#### Initialize a normal count up runner with a custom formatter function that displays the time in minutes (with decimals):
187194

@@ -207,6 +214,12 @@ $('#runner').runner({
207214

208215
## Changelog
209216

217+
### v2.3.0 - *2013-07-14* - Improvements and fixes
218+
* Runner now utilizes requestAnimationFrame if applicable and falls back to setTimeout
219+
* Fixed a small bug with dependency checks
220+
* Removed ability to tweak the runner interval due to requestAnimationFrame change
221+
* Now also serving a gzipped version of the minified runner code in build folder, only 1.6KB!
222+
210223
### v2.2.0 - *2013-05-24* - Feature improvements and fixes
211224
* Fixed a couple of small underlying bugs
212225
* The first lap-time value now takes under consideration if the startAt time was something else than 0

0 commit comments

Comments
 (0)