[rest-gradle-plugin] 14/83: Add installation and usage examples to the README

[Alastair McKinstry]

This is an automated email from the git hooks/post-receive script.

mckinstry pushed a commit to branch debian/master
in repository rest-gradle-plugin.

commit c4fdebed230ab39be2ce32582959709052d695d1
Author: noamt <noamt at jfrog.com>
Date:   Wed Apr 3 16:23:39 2013 +0300

    Add installation and usage examples to the README
---
 README.md | 27 +++++++++++++++++++++++++--
 1 file changed, 25 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index acd7d51..7b26b46 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,19 @@ A Gradle plugin that provides a task infrastructure to perform REST requests.
 Installation
 ------------
 
-TBD
+The plugin can be installed using the following snippet
+
+    buildscript {
+        repositories {
+            maven { url 'http://dl.bintray.com/content/noamt/gradle-plugins' }
+        }
+
+        dependencies {
+            classpath 'org._10ne.gradle:rest-gradle-plugin:0.1'
+        }
+    }
+
+    apply plugin: 'rest'
 
 Usage
 -----
@@ -19,4 +31,15 @@ The plugin adds a new task named `rest`. This task exposes the following propert
  * password - Authentication password. Type: String.
  * contentType - The expected content type of both request and response. Type: groovyx.net.http.ContentType / String.
  * requestContentType - The expected content type of the request. Overrides the `contentType` parameter. Type: groovyx.net.http.ContentType / String.
- * requestBody - The request content. Type: Object.
\ No newline at end of file
+ * requestBody - The request content. Type: Object.
+
+For example, a POST request task:
+
+    task attack(type: org._10ne.gradle.rest.RestTask) {
+        httpMethod = 'post'
+        uri = 'https://battle.server.com/attack'
+        username = 'player'
+        password = 'password'
+        requestBody = [battleCry: 'FOR LEEROY JENKINS!']
+        contentType = groovyx.net.http.ContentType.JSON
+    }
\ No newline at end of file

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-java/rest-gradle-plugin.git