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

- old
+ new

@@ -18,28 +18,43 @@ set :payload_url, "http://your.awesome.url.com/payload" To test if it works type: cap payload:deploy + +The best way to test out is to use http://www.postbin.org/. +## 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 structure -Plugin will sent JSON-encoded data via POST method. +Plugin will sent a payload in one of the formats (FORM, JSON, YAML, XML) data via POST method. -Here is the sample payload: +Here is an example data: { "capistrano": { + "version": "2.6.0", "application": "APP_NAME", - "deployer": "sosedoff", + "deployer": { + "user": "sosedoff", + "hostname": "localhost", + } "timestamp": "2011-07-21 19:09:52 -0500", + "message": "Release 1.0.0", "source": { "branch": "master", "revision": "b18ffa822c16c028765800d0c4d22bfd5e4f3bf9", "repository": "git@github.com:repository.git" }, "action": "deploy" - } + }, + "payload_version": "0.2.0" } That's it. Ready to roll. ## License \ No newline at end of file