Skip to content

Commit 3624d12

Browse files
committed
Update documentation
1 parent cb64b04 commit 3624d12

File tree

3 files changed

+8
-5
lines changed

3 files changed

+8
-5
lines changed

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Attributes
99
----------
1010

1111
* `running` _boolean_
12-
indicates whether the ticker is active
12+
indicates whether the ticker has been started
1313

1414
* `options` _object_
1515
all runtime options
@@ -23,12 +23,15 @@ Attributes
2323
* `separators` _array_
2424
a list of all separators
2525

26+
* `increment` _function_
27+
callback used to update @value on every tick
28+
2629

2730
Options
2831
-------
2932

30-
* `incremental` _int_
31-
the amount by which the target value is to be increased
33+
* `incremental` _mixed_
34+
can be either a fixed numeric value that gets added to the base value on each tick or a function that gets called with the current value and must return the updated number
3235

3336
* `delay` _int_
3437
the time in milliseconds after which the target value is being increased

assets/coffee/tick.coffee

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ $.fn.ticker = (options) ->
3636
separators array a list of the all separators that were found inbetween all digits
3737
all digits are represented by an empty element
3838
running boolean indicates whether the ticker has been started
39-
increment function callback used on every tick to update @value
39+
increment function callback used to update @value on every tick
4040
4141
Options
4242

assets/js/tick.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)