README.md in capistrano-stretcher-0.1.0 vs README.md in capistrano-stretcher-0.2.0

- old
+ new

@@ -18,29 +18,35 @@ $ gem install capistrano-stretcher ## Requirements -capistrano-stretcher requires target server for building to application assets. this server should be installed folloing packages: +capistrano-stretcher requires target server for building to application assets. This server should be installed the following packages: * git * rsync * tar * gzip * awk * openssl * aws-cli * consul -target server build assets, upload assets to AWS S3 and invoke `consul event` automatically. so target server can access AWS s3 via aws-cli and join your deployment consul cluster. +target server builds assets, uploads assets to AWS S3 and invokes `consul event` automatically. So target server can access AWS s3 via aws-cli and join your deployment consul cluster. ## Usage -You need to add `require "capistrano/stretcher" to Capfile` and add `config/deploy.rb` following variables: +You need to add `require "capistrano/stretcher"` to Capfile and add `config/deploy.rb` following variables: -``` +```ruby role :build, ['your-target-server.lan'], :no_release => true + +# If your build server is accessible to consul cluster, then set the same server +# If different, set a server that can access consul cluster +# just to kick consul event! +role :consul, ['your-target-server.lan'], :no_release => true + set :application, 'your-application' set :deploy_to, '/var/www' set :deploy_roles, 'www,batch' set :stretcher_hooks, 'config/stretcher.yml.erb' set :local_tarball_name, 'rails-applicaiton.tar.gz' @@ -77,10 +83,15 @@ and invoke * `consul event -name deploy_www_staging s3://.../manifest_www.yml` * `consul event -name deploy_batch_staging s3://.../manifest_batch.yml` -with `cap staging stretcher:deploy` command on target server. When it's invoked with `cap production stretcher:deploy`, capistrano-strecher replace suffix `staging` to `production`. +with `cap staging stretcher:deploy` command on target server. When it's invoked with `cap production stretcher:deploy`, capistrano-stretcher replace suffix `staging` to `production`. + +## Related Projects + + * [capistrano-stretcher-rails](https://github.com/pepabo/capistrano-stretcher-rails) + * [capistrano-stretcher-npm](https://github.com/pepabo/capistrano-stretcher-npm) ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.