Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updates to README.md

  • Loading branch information...
commit 4ff349371931ec837339aa9082c4ac7ddd4c7c35 1 parent bb49fe6
@mikeal mikeal authored
Showing with 6 additions and 1 deletion.
  1. +6 −1 README.md
View
7 README.md
@@ -8,6 +8,8 @@
## Super simple to use
+Request is designed to be the simplest way possible to make http calls. It support HTTPS and follows redirects by default.
+
#### request(options, callback)
The first argument is an options object. The only required option is uri, all others are optional.
@@ -17,6 +19,7 @@ The first argument is an options object. The only required option is uri, all ot
* `'headers'` - http headers, defaults to {}
* `'body'` - entity body for POST and PUT requests
* `'client'` - existing http client object (when undefined a new one will be created and assigned to this property so you can keep around a reference to it if you would like use keep-alive on later request)
+* '`followRedirect` - follow HTTP 3xx responses as redirects. defaults to true.
The callback argument gets 3 arguments. The first is an error when applicable (usually from the http.Client option not the http.ClientRequest object). The second in an http.ClientResponse object. The third is the response body buffer.
@@ -28,4 +31,6 @@ Example:
sys.puts(body) // Print the google web page.
}
})
-</pre>
+</pre>
+
+It's also worth noting that the options argument will mutate. When following a redirect the uri values will change. After setting up a client options it will set the client property.
Please sign in to comment.
Something went wrong with that request. Please try again.