Skip to content

Commit

Permalink
regen doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@benoitc
benoitc committed Jul 29, 2015
1 parent c12f952 commit 735f44e
Show file tree
Hide file tree
Showing 36 changed files with 190 additions and 538 deletions.
1 change: 1 addition & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ erl_crash.dump
mime.types
.rebar
*.plt
.rebar
44 changes: 4 additions & 40 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

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

__Version:__ 1.2.0
__Version:__ 1.3.1

# hackney

Expand Down Expand Up @@ -174,8 +174,8 @@ couple of requests.

```erlang

Transport = hackney_ssl_transport,
Host = << "friendpaste.com" >>,
Transport = hackney_tcp_transport,
Host = << "https://friendpaste.com" >>,
Port = 443,
Options = [],
{ok, ConnRef} = hackney:connect(Transport, Host, Port, Options)
Expand Down Expand Up @@ -425,7 +425,7 @@ automatically upgrading to an SSL connection if needed.

Hackney offers the following metrics

You can enable metrics collection by adding a `mod_metrics` entry to hackney’s
You can enable metrics collection by adding a `mod_metrics` entry to hackney's
app config. Metrics are disabled by default. The module specified must have an
API matching that of the hackney metrics module.

Expand Down Expand Up @@ -500,39 +500,3 @@ $ gunicorn --daemon --pid httpbin.pid httpbin:app
$ make test
$ kill `cat httpbin.pid`
```


## Modules ##


<table width="100%" border="0" summary="list of modules">
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney.md" class="module">hackney</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_app.md" class="module">hackney_app</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_bstr.md" class="module">hackney_bstr</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_connect.md" class="module">hackney_connect</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_cookie.md" class="module">hackney_cookie</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_date.md" class="module">hackney_date</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_deps.md" class="module">hackney_deps</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_dummy_metrics.md" class="module">hackney_dummy_metrics</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_exometer_metrics.md" class="module">hackney_exometer_metrics</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_folsom_metrics.md" class="module">hackney_folsom_metrics</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_headers.md" class="module">hackney_headers</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_http.md" class="module">hackney_http</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_http_connect.md" class="module">hackney_http_connect</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_idna.md" class="module">hackney_idna</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_manager.md" class="module">hackney_manager</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_mimetypes.md" class="module">hackney_mimetypes</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_multipart.md" class="module">hackney_multipart</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_pool.md" class="module">hackney_pool</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_pool_handler.md" class="module">hackney_pool_handler</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_request.md" class="module">hackney_request</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_response.md" class="module">hackney_response</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_socks5.md" class="module">hackney_socks5</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_ssl_transport.md" class="module">hackney_ssl_transport</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_stream.md" class="module">hackney_stream</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_sup.md" class="module">hackney_sup</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_tcp_transport.md" class="module">hackney_tcp_transport</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_trace.md" class="module">hackney_trace</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_url.md" class="module">hackney_url</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_util.md" class="module">hackney_util</a></td></tr></table>

44 changes: 4 additions & 40 deletions doc/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

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

__Version:__ 1.2.0
__Version:__ 1.3.1

# hackney

Expand Down Expand Up @@ -355,10 +355,10 @@ To close a pool do:
hackney_pool:stop_pool(PoolName).
```

> Note: Sometimes you want to always use the default pool in your app
> Note: Sometimes you want to disable the default pool in your app
> without having to set the client option each time. You can now do this
> by setting the hackney application environment key `use_default_pool`
> to true.
> to false.
### Use a custom pool handler.

Expand Down Expand Up @@ -425,7 +425,7 @@ automatically upgrading to an SSL connection if needed.

Hackney offers the following metrics

You can enable metrics collection by adding a `mod_metrics` entry to hackney’s
You can enable metrics collection by adding a `mod_metrics` entry to hackney's
app config. Metrics are disabled by default. The module specified must have an
API matching that of the hackney metrics module.

Expand Down Expand Up @@ -500,39 +500,3 @@ $ gunicorn --daemon --pid httpbin.pid httpbin:app
$ make test
$ kill `cat httpbin.pid`
```


## Modules ##


<table width="100%" border="0" summary="list of modules">
<tr><td><a href="hackney.md" class="module">hackney</a></td></tr>
<tr><td><a href="hackney_app.md" class="module">hackney_app</a></td></tr>
<tr><td><a href="hackney_bstr.md" class="module">hackney_bstr</a></td></tr>
<tr><td><a href="hackney_connect.md" class="module">hackney_connect</a></td></tr>
<tr><td><a href="hackney_cookie.md" class="module">hackney_cookie</a></td></tr>
<tr><td><a href="hackney_date.md" class="module">hackney_date</a></td></tr>
<tr><td><a href="hackney_deps.md" class="module">hackney_deps</a></td></tr>
<tr><td><a href="hackney_dummy_metrics.md" class="module">hackney_dummy_metrics</a></td></tr>
<tr><td><a href="hackney_exometer_metrics.md" class="module">hackney_exometer_metrics</a></td></tr>
<tr><td><a href="hackney_folsom_metrics.md" class="module">hackney_folsom_metrics</a></td></tr>
<tr><td><a href="hackney_headers.md" class="module">hackney_headers</a></td></tr>
<tr><td><a href="hackney_http.md" class="module">hackney_http</a></td></tr>
<tr><td><a href="hackney_http_connect.md" class="module">hackney_http_connect</a></td></tr>
<tr><td><a href="hackney_idna.md" class="module">hackney_idna</a></td></tr>
<tr><td><a href="hackney_manager.md" class="module">hackney_manager</a></td></tr>
<tr><td><a href="hackney_mimetypes.md" class="module">hackney_mimetypes</a></td></tr>
<tr><td><a href="hackney_multipart.md" class="module">hackney_multipart</a></td></tr>
<tr><td><a href="hackney_pool.md" class="module">hackney_pool</a></td></tr>
<tr><td><a href="hackney_pool_handler.md" class="module">hackney_pool_handler</a></td></tr>
<tr><td><a href="hackney_request.md" class="module">hackney_request</a></td></tr>
<tr><td><a href="hackney_response.md" class="module">hackney_response</a></td></tr>
<tr><td><a href="hackney_socks5.md" class="module">hackney_socks5</a></td></tr>
<tr><td><a href="hackney_ssl_transport.md" class="module">hackney_ssl_transport</a></td></tr>
<tr><td><a href="hackney_stream.md" class="module">hackney_stream</a></td></tr>
<tr><td><a href="hackney_sup.md" class="module">hackney_sup</a></td></tr>
<tr><td><a href="hackney_tcp_transport.md" class="module">hackney_tcp_transport</a></td></tr>
<tr><td><a href="hackney_trace.md" class="module">hackney_trace</a></td></tr>
<tr><td><a href="hackney_url.md" class="module">hackney_url</a></td></tr>
<tr><td><a href="hackney_util.md" class="module">hackney_util</a></td></tr></table>

1 change: 0 additions & 1 deletion doc/edoc-info
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
%% encoding: UTF-8
{application,hackney}.
{packages,[]}.
{modules,[hackney,hackney_app,hackney_bstr,hackney_connect,hackney_cookie,
hackney_date,hackney_deps,hackney_dummy_metrics,
hackney_exometer_metrics,hackney_folsom_metrics,hackney_headers,
Expand Down
Loading

0 comments on commit 735f44e

Please sign in to comment.