From f6f8648c4e470d5c714fc97e3f9affed42cee56b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Enrique=20Garc=C3=ADa=20Cota?= Date: Sun, 24 Apr 2011 17:08:22 +0200 Subject: [PATCH] update README --- README.textile | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.textile b/README.textile index c63ba3b..de0c2e6 100644 --- a/README.textile +++ b/README.textile @@ -4,9 +4,9 @@ h1. cron.lua h1. Examples of use -* @cron.after(time, callback)@ will execute callback after the given amount of time units. -* @cron.every(time, callback)@ will repeat the same action periodically. -* @cron.cancel(id)@ will stop a timed event from happening. @id@ is returned by @cron.after@ and @cron.every@ respectively. It will stop a timed event from happening, or stop a periodic action. +* @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.cancel(id)@ will stop a timed event from happening. It will stop a timed event from happening, or stop 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.