diff --git a/README.rdoc b/README.rdoc index 6f83663..171d56d 100644 --- a/README.rdoc +++ b/README.rdoc @@ -39,6 +39,28 @@ This will create an initial "config/schedule.rb" file you. More examples on the wiki: http://wiki.github.com/javan/whenever/instructions-and-examples +== Define your own job types + +Whenever ships with three pre-defined job types: command, runner, and rake. You can define your own with job_type. + +For example: + + job_type :awesome, '/usr/local/bin/awesome :task :fun_level' + + every 2.hours do + awesome "party", :fun_level => "extreme" + end + +Would run /usr/local/bin/awesome party extreme every two hours. :task is always replaced with the first argument, and any additional :whatevers are replaced with the options passed in or by variables that have been defined with set. + +The default job types that ship with Whenever are defined like so: + + job_type :command, ':task' + job_type :runner, 'cd :path && script/runner -e :environment ":task"' + job_type :rake, 'cd :path && RAILS_ENV=:environment /usr/bin/env rake :task' + +If a :path is not set it will default to the directory in which whenever was executed. :environment will default to 'production'. + == Cron output $ cd /my/rails/app diff --git a/lib/whenever/command_line.rb b/lib/whenever/command_line.rb index c101c1a..b8882f9 100644 --- a/lib/whenever/command_line.rb +++ b/lib/whenever/command_line.rb @@ -20,7 +20,7 @@ module Whenever end if [@options[:update], @options[:write], @options[:clear]].compact.length > 1 - warn("[fail] Can only update, write or delete. choose one.") + warn("[fail] Can only update, write or clear. Choose one.") exit(1) end end