From 570f8ed206b3cca2adddf39c5d4ff58cc41f91ca Mon Sep 17 00:00:00 2001 From: Sven Slootweg Date: Sun, 25 Aug 2019 18:45:27 +0200 Subject: [PATCH] Fix documentation formatting --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 2470161..5d147b0 100644 --- a/README.md +++ b/README.md @@ -84,20 +84,22 @@ After 500ms: Returns a new `timerObject`. The returned timer does *not* start running until you call its `start` method! Arguments: - - __options:__ - - __timeout:__ The timeout, in milliseconds, after which the timer should 'fire' by default. - - __onFire:__ A callback that will be called when the timer fires (ie. hits the timeout). - - __onCancel:__ *Optional.* A callback that will be called when the timer is cancelled (ie. stopped prematurely). + +- __options:__ + - __timeout:__ The timeout, in milliseconds, after which the timer should 'fire' by default. + - __onFire:__ A callback that will be called when the timer fires (ie. hits the timeout). + - __onCancel:__ *Optional.* A callback that will be called when the timer is cancelled (ie. stopped prematurely). ### timerObject.start([options]) Starts the timer (anew), first stopping it if it's already running. Arguments: - - __options:__ *Optional.* These settings will override the options that were used to create the `timerObject`, but *only* for this run. - - __timeout:__ *Optional.* The timeout, in milliseconds, after which the timer should 'fire' on *this run*. - - __onFire:__ *Optional.* A callback that will be called when the timer fires on *this run*. - - __onCancel:__ *Optional.* A callback that will be called when *this run* of the timer is cancelled. + +- __options:__ *Optional.* These settings will override the options that were used to create the `timerObject`, but *only* for this run. + - __timeout:__ *Optional.* The timeout, in milliseconds, after which the timer should 'fire' on *this run*. + - __onFire:__ *Optional.* A callback that will be called when the timer fires on *this run*. + - __onCancel:__ *Optional.* A callback that will be called when *this run* of the timer is cancelled. ### timerObject.stop() @@ -109,6 +111,10 @@ Returns a boolean indicating whether the timer is currently running or not. ## Changelog +### 1.0.1 (August 25, 2019) + +- Fixed documentation formatting. + ### 1.0.0 (August 25, 2019) Initial release.