Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jetz committed May 16, 2014
1 parent c56c75d commit 92f1338
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ API

request
---
`syntax: local res, err = http:new(host, port, options)`
`syntax: local res, err = http.request(host, port, options?)`

Perform an http request.

Expand All @@ -51,6 +51,8 @@ An optional Lua `options` table can be specified to declare various options:
: Specifies query parameters. Accepts either a string or a Lua table.
* `headers`
: Specifies request headers. Accepts a Lua table.
* `body`
: Specifies request body for POST method. Only accepts a string.
* `timeout`
: Sets the timeout in milliseconds for network operations. Defaults to `5000`.
* `version`
Expand Down

0 comments on commit 92f1338

Please sign in to comment.