Commit f60dacd3 by Andrew Babichev

Adjust README with options

parent 1afdcc0b
......@@ -6,36 +6,44 @@
Add this line to your application's Gemfile:
```ruby
gem 'capistrano-sneakers'
```
gem 'capistrano-sneakers', github: 'inventionlabsSydney/capistrano-sneakers'
And then execute:
$ bundle
Or install it yourself as:
$ gem install capistrano-sneakers
## Usage
## Usage
```ruby
# Capfile
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
- [Andrew Babichev](https://github.com/Tensho)
- [NaixSpirit](https://github.com/NaixSpirit)
## 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`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment