README.md in capistrano-foreman-0.0.3 vs README.md in capistrano-foreman-1.0.0
- old
+ new
@@ -1,17 +1,41 @@
# Capistrano Foreman
+[](https://codeclimate.com/github/hyperoslo/capistrano-foreman)
+
Capistrano tasks for foreman and upstart.
## Installation
$ gem install capistrano-foreman
+Add this to your `Capfile`:
+
+```ruby
+require 'capistrano/foreman'
+
+# Default settings
+set :foreman_sudo, 'sudo' # Set to `rvmsudo` if you're using RVM
+set :foreman_upstart_path, '/etc/init/sites' # Set to `/etc/init/` if you don't have a sites folder
+set :foreman_options, {
+ app: application,
+ log: "#{shared_path}/log",
+ user: user,
+}
+```
+
+See [exporting options](http://ddollar.github.io/foreman/#EXPORTING0) for an exhaustive list of foreman options.
+
## Usage
Export Procfile to upstart:
$ cap foreman:export
Restart the application services:
$ cap foreman:restart
+
+## Credits
+
+Hyper made this. We're a digital communications agency with a passion for good code,
+and if you're using this library we probably want to hire you.