[rest-gradle-plugin] 28/83: Rewrite readme in asciidoc

Alastair McKinstry mckinstry at moszumanska.debian.org
Wed Oct 25 15:59:04 UTC 2017


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 255407f4ba1bffe5fcba8d1fdf6f0b9415774a64
Author: noamt <noam at 10ne.org>
Date:   Sun Aug 10 11:31:09 2014 +0300

    Rewrite readme in asciidoc
---
 README.asciidoc | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 README.md       | 47 -----------------------------------------------
 2 files changed, 49 insertions(+), 47 deletions(-)

diff --git a/README.asciidoc b/README.asciidoc
new file mode 100644
index 0000000..3181ff0
--- /dev/null
+++ b/README.asciidoc
@@ -0,0 +1,49 @@
+= REST Gradle Plugin =
+
+== A Gradle plugin that provides a task infrastructure to perform REST requests ==
+
+=== Installation ===
+
+The plugin can be installed using the following snippet
+
+[source,groovy]
+----
+buildscript {
+    repositories {
+        maven { url 'http://dl.bintray.com/content/noamt/gradle-plugins' }
+        jcenter()
+    }
+
+    dependencies {
+        classpath 'org._10ne.gradle:rest-gradle-plugin:0.1'
+    }
+}
+
+apply plugin: 'rest'
+----
+
+=== 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.
+* requestHeaders - Additional request headers. Type: Map.
+
+For example, a POST request task:
+[source,groovy]
+----
+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
+    requestHeaders = [customHeader: 'WoW']
+}
+----
\ No newline at end of file
diff --git a/README.md b/README.md
deleted file mode 100644
index 44b8f03..0000000
--- a/README.md
+++ /dev/null
@@ -1,47 +0,0 @@
-REST Gradle Plugin
-==================
-
-A Gradle plugin that provides a task infrastructure to perform REST requests.
-
-Installation
-------------
-
-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
------
-
-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.
- * requestHeaders - Additional request headers. Type: Map.
-
-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
-        requestHeaders = [customHeader: 'WoW']
-    }
\ 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



More information about the pkg-java-commits mailing list