Skip to content

Commit

Permalink
sync doc
Browse files Browse the repository at this point in the history
  • Loading branch information
benoitc committed Apr 14, 2014
1 parent 5b5515f commit fbc02e9
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@


# hackney - HTTP client library in Erlang #

Copyright (c) 2012-2014 Benoît Chesneau.

__Version:__ 0.11.1
__Version:__ 0.11.2

# hackney

Expand Down Expand Up @@ -374,8 +375,7 @@ Options = [{follow_redirect, true}, {max_redirect, true}],

To use an HTTP tunnel add the option `{proxy, ProxyUrl}` where
`ProxyUrl` can be a simple url or an `{Host, Port}` tuple. If you need
to authenticate set the option `{proxy_auth, {User, Password}}`
(use binaries for username and password).
to authenticate set the option `{proxy_auth, {User, Password}}`.

#### SOCKS5 proxy

Expand Down
9 changes: 8 additions & 1 deletion doc/hackney_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,20 @@ module handling the request.
## Function Index ##


<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#encode_form-1">encode_form/1</a></td><td>encode a list of properties in a form.</td></tr><tr><td valign="top"><a href="#end_stream_body-1">end_stream_body/1</a></td><td></td></tr><tr><td valign="top"><a href="#is_default_port-1">is_default_port/1</a></td><td></td></tr><tr><td valign="top"><a href="#location-1">location/1</a></td><td></td></tr><tr><td valign="top"><a href="#make_multipart_stream-2">make_multipart_stream/2</a></td><td></td></tr><tr><td valign="top"><a href="#perform-2">perform/2</a></td><td></td></tr><tr><td valign="top"><a href="#send-2">send/2</a></td><td></td></tr><tr><td valign="top"><a href="#send_chunk-2">send_chunk/2</a></td><td></td></tr><tr><td valign="top"><a href="#sendfile-3">sendfile/3</a></td><td></td></tr><tr><td valign="top"><a href="#stream_body-2">stream_body/2</a></td><td></td></tr><tr><td valign="top"><a href="#stream_multipart-2">stream_multipart/2</a></td><td>stream multipart.</td></tr></table>
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#default_ua-0">default_ua/0</a></td><td></td></tr><tr><td valign="top"><a href="#encode_form-1">encode_form/1</a></td><td>encode a list of properties in a form.</td></tr><tr><td valign="top"><a href="#end_stream_body-1">end_stream_body/1</a></td><td></td></tr><tr><td valign="top"><a href="#is_default_port-1">is_default_port/1</a></td><td></td></tr><tr><td valign="top"><a href="#location-1">location/1</a></td><td></td></tr><tr><td valign="top"><a href="#make_multipart_stream-2">make_multipart_stream/2</a></td><td></td></tr><tr><td valign="top"><a href="#perform-2">perform/2</a></td><td></td></tr><tr><td valign="top"><a href="#send-2">send/2</a></td><td></td></tr><tr><td valign="top"><a href="#send_chunk-2">send_chunk/2</a></td><td></td></tr><tr><td valign="top"><a href="#sendfile-3">sendfile/3</a></td><td></td></tr><tr><td valign="top"><a href="#stream_body-2">stream_body/2</a></td><td></td></tr><tr><td valign="top"><a href="#stream_multipart-2">stream_multipart/2</a></td><td>stream multipart.</td></tr></table>


<a name="functions"></a>

## Function Details ##

<a name="default_ua-0"></a>

### default_ua/0 ###

`default_ua() -> any()`


<a name="encode_form-1"></a>

### encode_form/1 ###
Expand Down
2 changes: 1 addition & 1 deletion doc/utf8/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Copyright (c) 2012-2014 Benoît Chesneau.

__Version:__ 0.11.1
__Version:__ 0.11.2

# hackney

Expand Down

0 comments on commit fbc02e9

Please sign in to comment.