From 2dbfcc7350797143a09580e2a1dc7b70fd8de321 Mon Sep 17 00:00:00 2001 From: Tanner Rogalsky Date: Tue, 11 Jun 2013 12:42:13 -0400 Subject: [PATCH] Update the readme --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index b7bb00d..613ba13 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ API * `cron.after(time, callback)` will execute callback after the given amount of time units. Returns an identifier (`id`) * `cron.every(time, callback)` will repeat the same action periodically. Returns an identifier (`id`) +* `cron.doFor(time, callback)` will execute a callback every time `cron.update` is called until the timer expires. Returns an identifier (`id`) * `cron.cancel(id)` will stop a timed action from happening, and will interrupt the periodical execution of a periodic action. * `cron.reset()` removes all timed and periodic actions, and resets the time passed back to 0. * `cron.update(dt)` is needed to be executed on the main program loop. `dt` is the amount of time that has passed since the last iteration. When `cron.update` is executed, cron will check the list of pending actions and execute them if needed.