README.md in capistrano-sidekiq-0.0.1 vs README.md in capistrano-sidekiq-0.0.2

- old
+ new

@@ -6,17 +6,41 @@ Add this line to your application's Gemfile: gem 'capistrano-sidekiq' , github: 'seuros/capistrano-sidekiq' +or: + gem 'capistrano-sidekiq' + And then execute: $ bundle + ## Usage +```ruby + # Capfile -TODO: Write usage instructions here + require 'capistrano/sidekiq' +``` + + +Configurable options, shown here with defaults: + +```ruby + :sidekiq_default_hooks => true + :sidekiq_pid => File.join(shared_path, 'tmp', 'pids', 'sidekiq.pid') + :sidekiq_env => fetch(:rack_env, fetch(:rails_env, fetch(:stage))) + :sidekiq_log => File.join(shared_path, 'log', 'sidekiq.log') + :sidekiq_options => "-e #{fetch(:sidekiq_env)} -L #{fetch(:sidekiq_log)}" + :sidekiq_timeout => 10 + :sidekiq_role => :app + :sidekiq_processes => 1 + :sidekiq_cmd => "#{fetch(:bundle_cmd, "bundle")} exec sidekiq" # Only for capistrano2.5 + :sidekiqctl_cmd => "#{fetch(:bundle_cmd, "bundle")} exec sidekiqctl" # Only for capistrano2.5 +``` + ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`)