Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
pfleidi committed May 1, 2011
1 parent fb93a64 commit c54e961
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit c54e961

Please sign in to comment.