update readme for syntax highlighting

README.md

@@ -4,44 +4,50 @@ Whenever is a Ruby gem that provides a clear syntax for writing and deploying cr
 
 ### Installation
 
-    $ gem install whenever
+```sh  
+$ gem install whenever
+```
 
 Or with Bundler in your Gemfile.
 
-    gem 'whenever', :require => false
+```ruby
+gem 'whenever', :require => false
+```
  
 ### Getting started
 
-    $ cd /my/rails/app
+```sh
-    $ wheneverize .
+$ cd /my/rails/app
+$ wheneverize .
+```
 
-This will create an initial "config/schedule.rb" file you.
+This will create an initial `config/schedule.rb` file you.
 
 ### Example schedule.rb file
 
-    every 3.hours do
+```ruby  
+every 3.hours do
   runner "MyModel.some_process"       
   rake "my:rake:task"                 
   command "/usr/bin/my_great_command"
-    end
+end
 
-    every 1.day, :at => '4:30 am' do 
+every 1.day, :at => '4:30 am' do 
   runner "MyModel.task_to_run_at_four_thirty_in_the_morning"
-    end
+end
 
-    every :hour do # Many shortcuts available: :hour, :day, :month, :year, :reboot
+every :hour do # Many shortcuts available: :hour, :day, :month, :year, :reboot
   runner "SomeModel.ladeeda"
-    end
+end
 
-    every :sunday, :at => '12pm' do # Use any day of the week or :weekend, :weekday 
+every :sunday, :at => '12pm' do # Use any day of the week or :weekend, :weekday 
   runner "Task.do_something_great"
-    end
+end
 
-    every '0 0 27-31 * *' do
+every '0 0 27-31 * *' do
   command "echo 'you can use raw cron syntax too'"
-    end
+end
-
+```
-More examples on the wiki: <http://wiki.github.com/javan/whenever/instructions-and-examples>
 
 ### Define your own job types
 
@@ -49,23 +55,29 @@ Whenever ships with three pre-defined job types: command, runner, and rake. You
 
 For example:
 
-    job_type :awesome, '/usr/local/bin/awesome :task :fun_level'
+```ruby
+job_type :awesome, '/usr/local/bin/awesome :task :fun_level'
 
-    every 2.hours do
+every 2.hours do
   awesome "party", :fun_level => "extreme"
-    end
+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 :output"
+```ruby
-    job_type :rake,    "cd :path && RAILS_ENV=:environment rake :task :output"
+job_type :command, ":task :output"
-    job_type :runner,  "cd :path && script/runner -e :environment ':task' :output"
+job_type :rake,    "cd :path && RAILS_ENV=:environment rake :task :output"
+job_type :runner,  "cd :path && script/runner -e :environment ':task' :output"
+```
   
-If a script/rails file is detected (like in a Rails 3 app), runner will be defined to fit:
+If a `script/rails` file is detected (like in a Rails 3 app), runner will be defined to fit:
 
-    job_type :runner,  "cd :path && script/rails runner -e :environment ':task' :output"
+```ruby
+job_type :runner,  "cd :path && script/rails runner -e :environment ':task' :output"
+```
 
 If a `:path` is not set it will default to the directory in which `whenever` was executed. `:environment` will default to 'production'. `:output` will be replaced with your output redirection settings which you can read more about here: <http://github.com/javan/whenever/wiki/Output-redirection-aka-logging-your-cron-jobs>
 
@@ -73,13 +85,17 @@ All jobs are by default run with `bash -l -c 'command...'`. Among other things,
 
 You can change this by setting your own `:job_template`.
 
-    set :job_template, "bash -l -c ':job'"
+```ruby
+set :job_template, "bash -l -c ':job'"
+```
   
 Or set the job_template to nil to have your jobs execute normally.
 
-    set :job_template, nil
+```ruby
+set :job_template, nil
+```
 
-And you'll see your schedule.rb converted to cron sytax. Note: running `whenever` with no options does not display your current crontab file, it simply shows you the output of converting your schedule.rb file.
+And you'll see your `schedule.rb` converted to cron sytax. Note: running `whenever` with no options does not display your current crontab file, it simply shows you the output of converting your `schedule.rb` file.
 
 ### Capistrano integration
 
@@ -87,35 +103,43 @@ Use the built-in Capistrano recipe for easy crontab updates with deploys.
 
 In your "config/deploy.rb" file:
 
-    require "whenever/capistrano"
+```ruby
+require "whenever/capistrano"
+```
 
 Take a look at the recipe for options you can set. <http://github.com/javan/whenever/blob/master/lib/whenever/capistrano.rb>
 For example, if you're using bundler do this:
 
-    set :whenever_command, "bundle exec whenever"
+```ruby
-    require "whenever/capistrano"
+set :whenever_command, "bundle exec whenever"
+require "whenever/capistrano"
+```
 
 If you are using different environments (such as staging, production), then you may want to do this:
 
-    set :whenever_environment, defer { stage }
+```ruby
-    require "whenever/capistrano"
+set :whenever_environment, defer { stage }
+require "whenever/capistrano"
+```
 
-The capistrano variable `:stage` should be the one holding your environment name. This will make the correct `:environment` available in your schedule.rb.
+The capistrano variable `:stage` should be the one holding your environment name. This will make the correct `:environment` available in your `schedule.rb`.
 
 ### RVM Integration
 
 If your production environment uses RVM (Ruby Version Manager) you will run into a gotcha that causes your cron jobs to hang.  This is not directly related to Whenever, and can be tricky to debug.  Your .rvmrc files must be trusted or else the cron jobs will hang waiting for the file to be trusted.  A solution is to disable the prompt by adding this line to your user rvm file in `~/.rvmrc`
 
-    rvm_trust_rvmrcs_flag=1
+`rvm_trust_rvmrcs_flag=1`
 
 This tells rvm to trust all rvmrc files, which is documented here: http://wayneeseguin.beginrescueend.com/2010/08/22/ruby-environment-version-manager-rvm-1-0-0/
 
 ### The `whenever` command
 
-    $ cd /my/rails/app
+```sh
-    $ whenever
+$ cd /my/rails/app
+$ whenever
+```
   
-This will simply show you your schedule.rb file converted to cron syntax. It does not read or write your crontab file. Run `whenever --help` for a complete list of options.
+This will simply show you your `schedule.rb` file converted to cron syntax. It does not read or write your crontab file. Run `whenever --help` for a complete list of options.
 
 ### Credit
 
@@ -134,10 +158,8 @@ It's a little bit dated now, but remains a good introduction.
 
 ----
 
-[![Build Status](http://travis-ci.org/javan/whenever.png)](http://travis-ci.org/javan/whenever)
+Compatible with Ruby 1.8.7-1.9.2, JRuby, and Rubinius. [![Build Status](https://secure.travis-ci.org/javan/whenever.png)](http://travis-ci.org/javan/whenever)
-
-Compatible with Ruby 1.8.7-1.9.2, JRuby, and Rubinius.
 
 ----
 
-Copyright (c) 2011 Javan Makhmali
+Copyright &copy; 2011 Javan Makhmali