README.md in instrumental_tools-0.3.2 vs README.md in instrumental_tools-0.4.0

- old
+ new

@@ -23,5 +23,32 @@ Collect statistics on commit counts in a given git repo. Execute in the repo directory with: ```sh gitstrumental [INSTRUMENTAL_API_KEY] ``` + +## Capistrano Integration + +Add `require "instrumental_tools/capistrano"` to your capistrano +configuration and instrument_server will be restarted after your +deploy is finished. Additionally, you will need to add a new variable +to your capistrano file. + +```ruby +set :instrumental_key, "YOUR_KEY_HERE" +``` + +The following configuration will be added: + +```ruby +after "deploy", "instrumental:restart_instrument_server" +after "deploy:migrations", "instrumental:restart_instrument_server" +``` + +By default, this will attempt to restart the instrument_server command +on all the servers specified in your configuration. If you need to +limit the servers on which you restart the server, you can do +something like this in your capistrano configuration: + +```ruby +namespaces[:instrumental].tasks[:restart_instrument_server].options[:roles] = [:web, :worker] +```