README.md in capistrano-payload-0.3.0 vs README.md in capistrano-payload-0.4.0

- old
+ new

@@ -1,6 +1,5 @@ - # Capistrano Payload Capistrano plugin that delivers JSON-encoded deployment information via POST to the URL of your choice. ## Installation @@ -21,40 +20,40 @@ cap payload:deploy The best way to test out is to use http://www.postbin.org/. -## Options +## Configuration options - payload_url — Primary URL where the data would be sent (required) - payload_format — Payload format. Must be one of :json (default), :form, :yaml, :xml - payload_params — Extra parameters to the request (api_key, etc.). *Note: extra parameters wont be added to the payload.* -- payload_message — Ask for deployment comment. (default: true) +- payload_prompt — Ask for deployment comment. (default: true) ## Payload structure Plugin will sent a payload in one of the formats (FORM, JSON, YAML, XML) data via POST method. Here is an example data: { "capistrano": { "version": "2.6.0", - "application": "APP_NAME", + "application": "foobar", "deployer": { - "user": "sosedoff", - "hostname": "localhost", - } - "timestamp": "2011-07-21 19:09:52 -0500", - "message": "Release 1.0.0", + "user": "username", + "hostname": "localhost" + }, + "timestamp": "2011-01-01 00:00:00 -0600", "source": { "branch": "master", - "revision": "b18ffa822c16c028765800d0c4d22bfd5e4f3bf9", - "repository": "git@github.com:repository.git" + "revision": "abcdef", + "repository": "git@github.com:username/repo.git" }, - "action": "deploy" + "action": "deploy", + "message": "Comment" }, - "payload_version": "0.2.0" + "payload_version": "0.4.0" } That's it. Ready to roll. ## License \ No newline at end of file