Adjust README with options

README.md

@@ -6,36 +6,44 @@
 
 
 Add this line to your application's Gemfile:
 Add this line to your application's Gemfile:
 
 
-```ruby
-gem 'capistrano-sneakers'
-```
+    gem 'capistrano-sneakers', github: 'inventionlabsSydney/capistrano-sneakers'
 
 
 And then execute:
 And then execute:
 
 
     $ bundle
     $ bundle
 
 
-Or install it yourself as:
-
-    $ gem install capistrano-sneakers
-
 ## Usage
 ## Usage
 
 
-## Usage
 ```ruby
 ```ruby
 # Capfile
 # Capfile
-
 require 'capistrano/sneakers'
 require 'capistrano/sneakers'
-# Include monit tasks
-# require 'capistrano/sneakers/monit'
+require 'capistrano/sneakers/monit' # optional, to require monit tasks
+```
+
+Configurable options, shown here with defaults:
+
+```ruby
+:sneakers_default_hooks => true
+:sneakers_pid => File.join(shared_path, 'tmp', 'pids', 'sneakers.pid') # ensure this path exists in production before deploying
+:sneakers_env => fetch(:rack_env, fetch(:rails_env, fetch(:stage)))
+:sneakers_log => File.join(shared_path, 'log', 'sneakers.log')
+:sneakers_role => :app
+:sneakers_processes => 1
+# sneakers monit
+:sneakers_monit_conf_dir => '/etc/monit/conf.d'
+:sneakers_monit_use_sudo => true
+:sneakers_monit_bin => '/usr/bin/monit'
+:sneakers_monit_templates_path => 'config/deploy/templates'
 ```
 ```
 
 
 ## Contributors
 ## Contributors
 
 
+- [Andrew Babichev](https://github.com/Tensho)
 - [NaixSpirit](https://github.com/NaixSpirit)
 - [NaixSpirit](https://github.com/NaixSpirit)
 
 
 ## Contributing
 ## Contributing
 
 
-1. Fork it ( https://github.com/NaixSpirit/capistrano-sneakers/fork )
+1. Fork it (https://github.com/inventionlabsSydney/capistrano-sneakers)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 4. Push to the branch (`git push origin my-new-feature`)