Skip to content

Commit

Permalink
adds Configuration section to the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
pavlo committed Feb 24, 2012
1 parent 848d771 commit e8a1ae1
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,29 @@ You can set more than one timing:
# send reminders at noon and evening


Configuration
-----------------------

Clockwork exposes a couple of configuration options you may change:

### :logger

By default Clockwork logs to STDOUT. In case you prefer to make it to use our
own logger implementation you have to specify the `logger` configuration option. See example below.

### :sleep_timeout

Clockwork wakes up once a second (by default) and performs its duties. If that
is the rare case you need to tweak the number of seconds it sleeps then you have
the `sleep_timeout` configuration option to set like shown below.

### Configuration example

Clockwork.configure do |config|
config[:sleep_timeout] = 5
config[:logger] = Logger.new(log_file_path)
end

Anatomy of a clock file
-----------------------

Expand Down

0 comments on commit e8a1ae1

Please sign in to comment.