README.md in capistrano3-foreman-0.2.0 vs README.md in capistrano3-foreman-0.2.3
- old
+ new
@@ -1,25 +1,40 @@
# Capistrano::Foreman
-TODO: Write a gem description
+Capistrano V3 for foreman
+## WIP
+
+There be dragons, proceed at your own risk.
+
## Installation
Add this line to your application's Gemfile:
- gem 'capistrano-foreman'
+ gem 'capistrano3-foreman'
And then execute:
$ bundle
Or install it yourself as:
- $ gem install capistrano-foreman
+ $ gem install capistrano3-foreman
## Usage
-TODO: Write usage instructions here
+Require in Capfile to use the default task:
+
+ require 'capistrano/foreman'
+
+
+**Export Procfile to upstart**
+
+This task will be run before `deploy:restart` as part of Capistrano's default deploy, or can be run in isolation with:
+
+ cap production foreman:export
+
+
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)