README.md in clockwork-2.0.4 vs README.md in clockwork-3.0.0
- old
+ new
@@ -1,6 +1,6 @@
-Clockwork - a clock process to replace cron [](https://travis-ci.org/Rykian/clockwork)
+Clockwork - a clock process to replace cron [](https://travis-ci.org/Rykian/clockwork)
===========================================
Cron is non-ideal for running scheduled application tasks, especially in an app
deployed to multiple machines. [More details.](http://adam.herokuapp.com/past/2010/4/13/rethinking_cron/)
@@ -169,10 +169,12 @@
- `ignored_attributes` *(optional)* returning an array of model attributes (as symbols) to ignore when determining whether the database event has been modified since our last run
- `tz` *(optional)* returning the timezone to use (default is the local timezone)
+ - `skip_first_run` *(optional)* self explanatory, see [dedicated section](#skip_first_run)
+
#### Example Setup
Here's an example of one way of setting up your ActiveRecord models:
```ruby
@@ -500,10 +502,10 @@
Stalker.enqueue('leap.year.party') if Date.leap?(Time.now.year)
end
```
In addition, Clockwork also supports `:before_tick`, `:after_tick`, `:before_run`, and `:after_run` callbacks.
-All callbacks are optional. The `tick` callbacks run every tick (a tick being whatever your `:sleep_timeout`
+All callbacks are optional. All `before` callbacks must return a truthy value otherwise the job will not run. The `tick` callbacks run every tick (a tick being whatever your `:sleep_timeout`
is set to, default is 1 second):
```ruby
on(:before_tick) do
puts "tick"