Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Update README

  • Loading branch information...
commit c54e96113431ced4ef775de3966a0df58af46276 1 parent fb93a64
@pfleidi authored
Showing with 10 additions and 5 deletions.
  1. +10 −5 README.md
View
15 README.md
@@ -74,26 +74,31 @@ Creates a new client object with predefined options for each request made with t
The createClient call returns a Request object. On this object you can call a method for each supported HTTP verb.
-### client.get(url[, customHeaders])
+### client.get(url[, requestOptions])
Creates a HTTP GET request
-### client.put(url, payload[, customHeaders])
+### client.put(url [, requestOptions])
Creates a HTTP PUT request
-### client.post(url, payload[, customHeaders])
+### client.post(url, [, requestOptions])
Creates a HTTP POST request
-### client.delete(url[, customHeaders)]
+### client.delete(url[, requestOptions])
Creates a HTTP DELETE request
-### client.head(url[, customHeaders)]
+### client.head(url[, requestOptions)]
Creates a HTTP HEAD request
+### requestOptions hash
+
+* _headers_ see customHeaders
+* _payload_ content to transmit with PUT or POST request
+
### customHeaders hash
The customHeaders hash contains a set of HTTP headers which should be added to a request. They are optional. A working example would be:
Please sign in to comment.
Something went wrong with that request. Please try again.