[rest-gradle-plugin] 07/83: Provide more usage details in the read me file

[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 68be995257c20ce0d0aedde449d1e5af835a88e8
Author: noamt <noamt at jfrog.com>
Date:   Mon Feb 25 16:05:54 2013 +0200

    Provide more usage details in the read me file
---
 README.md | 22 ++++++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 5dfcc20..acd7d51 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,22 @@
-rest-gradle-plugin
+REST Gradle Plugin
 ==================
 
-A Gradle plugin that provides a REST request task infrastructure 
\ No newline at end of file
+A Gradle plugin that provides a task infrastructure to perform REST requests.
+
+Installation
+------------
+
+TBD
+
+Usage
+-----
+
+The plugin adds a new task named `rest`. This task exposes the following properties:
+
+ * httpMethod - The type of HTTP method to execute. Type: String. Default: `get`. Possible values: `delete`, `get`, `head`, `options`, `post`, `put`.
+ * uri - The target URI of the request. An invocation of toString() on the value should result in a valid URI. Type: Object.
+ * username - Authentication username. Type: String.
+ * 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

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