Skip to content

Commit e1bf774

Browse files
committed
Clarify docs.
1 parent b7cfcf3 commit e1bf774

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.markdown

+8-8
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ if($result->info->http_code == 200)
2929
Configurable Options
3030
--------------------
3131
`headers` - An associative array of HTTP headers and values to be included in every request.
32-
`parameters` - An associative array of parameters to be merged with individual request parameters in every request.
33-
`curl_options` - cURL options to apply to every request. These will override any automatically generated values.
34-
`user_agent` - User agent string.
32+
`parameters` - An associative array of URL or body parameters to be included in every request.
33+
`curl_options` - cURL options to apply to every request; anything defined here: https://secure.php.net/manual/en/function.curl-setopt.php. These will override any automatically generated values.
34+
`user_agent` - User agent string to use in requests.
3535
`base_url` - URL to use for the base of each request.
36-
`format` - Format to append to resource and support decoding.
37-
`format_regex` - Pattern to extract format from response Content-Type header.
38-
`decoders` - Associative array of format decoders, see documentation below.
39-
`username` - Username to use for basic authentication. Requires `password`.
40-
`password` - Password to use for basic authentication. Requires `username`.
36+
`format` - Format string is appended to resource on request (extension), and used to determine which decoder to use on response; a request URL like "api.twitter.com/1.1/statuses/user_timeline.json" would be expected to return well-formed JSON.
37+
`format_regex` - Pattern to extract format from response Content-Type header, used to determine which decoder to use on response.
38+
`decoders` - Associative array of format decoders. See ["Direct Iteration and Response Decoding"](#direct-iteration-and-response-decoding).
39+
`username` - Username to use for HTTP basic authentication. Requires `password`.
40+
`password` - Password to use for HTTP basic authentication. Requires `username`.
4141

4242
Options can be set upon instantiation, or individually afterword:
4343

0 commit comments

Comments
 (0)