README.md in capistrano-deployinfo-0.0.2 vs README.md in capistrano-deployinfo-1.0.0
- old
+ new
@@ -1,25 +1,49 @@
# Capistrano::Deployinfo
-TODO: Write a gem description
+A Capistrano extension that writes information about the deploy to a JSON file in a public spot. This is intended to quickly answer the question "What's on production?"
+
## Installation
Add this line to your application's Gemfile:
- gem 'capistrano-deployinfo'
+ gem 'capistrano', '~> 3.1'
+ gem 'capistrano-deployinfo', '~> 1.0'
And then execute:
- $ bundle
+ $ bundle install
-Or install it yourself as:
+## Usage
- $ gem install capistrano-deployinfo
+ # Capfile
+ require 'capistrano/deployinfo'
-## Usage
-TODO: Write usage instructions here
+ # config/deploy.rb
+ set :deployinfo_roles, :all # default value
+ set :deployinfo_dir, 'public' # default value
+ set :deployinfo_filename, 'deploy.json' # default value
+
+## Configs
+
+* `deployinfo_roles` which roles to generate the deploy info file
+* `deployinfo_dir` the directory to place the deploy info file
+* `deployinfo_filename` what to name the deploy info file
+
+## Example deploy.json
+
+```json
+{
+app: "my-app",
+deployed_at: "2014-02-26 00:25:33 -0500",
+branch: "master",
+user: "bob",
+sha: "7cf044f",
+release: "20140226052444"
+}
+```
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)