Skip to content

Commit 1fac9c7

Browse files
committed
fix doc
1 parent e61da0b commit 1fac9c7

File tree

4 files changed

+39
-23
lines changed

4 files changed

+39
-23
lines changed

NEWS.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,13 @@
11
# NEWS
2+
3+
1.22.0 - 2025-02-20
4+
-------------------
5+
6+
- feature: prefer to connect using IPv6. happy eyeball strategy
7+
- improvement: fully support no_proxy environment variable
8+
- doc: migrated to ex_doc
9+
10+
211
1.21.0 - 2025-02-20
312
-------------------
413

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Copyright (c) 2012-2025 Benoît Chesneau.
66

7-
__Version:__ 1.21.0
7+
__Version:__ 1.22.0
88

99
# hackney
1010

@@ -38,18 +38,18 @@ information on what still needs to be done.
3838

3939
#### Useful modules are:
4040

41-
- [`hackney`](http://github.com/benoitc/hackney/blob/master/doc/hackney.md): main module. It contains all HTTP client functions.
42-
- [`hackney_http`](http://github.com/benoitc/hackney/blob/master/doc/hackney_http.md): HTTP parser in pure Erlang. This parser is able
41+
- [`hackney`](https://hexdocs.pm/hackney/hackney.html): main module. It contains all HTTP client functions.
42+
- [`hackney_http`](https://hexdocs.pm/hackney/hackney_http.html): HTTP parser in pure Erlang. This parser is able
4343
to parse HTTP responses and requests in a streaming fashion. If not set
4444
it will be autodetected if it's a request or a response that's needed.
4545

46-
- [`hackney_headers`](http://github.com/benoitc/hackney/blob/master/doc/hackney_headers.md) Module to manipulate HTTP headers.
47-
- [`hackney_cookie`](http://github.com/benoitc/hackney/blob/master/doc/hackney_cookie.md): Module to manipulate cookies.
48-
- [`hackney_multipart`](http://github.com/benoitc/hackney/blob/master/doc/hackney_multipart.md): Module to encode/decode multipart.
49-
- [`hackney_url`](http://github.com/benoitc/hackney/blob/master/doc/hackney_url.md): Module to parse and create URIs.
50-
- [`hackney_date`](http://github.com/benoitc/hackney/blob/master/doc/hackney_date.md): Module to parse HTTP dates.
46+
- [`hackney_headers`](https://hexdocs.pm/hackney/hackney_headers.html) Module to manipulate HTTP headers.
47+
- [`hackney_cookie`](https://hexdocs.pm/hackney/hackney_cookie.html): Module to manipulate cookies.
48+
- [`hackney_multipart`](https://hexdocs.pm/hackney/hackney_multipart.html): Module to encode/decode multipart.
49+
- [`hackney_url`](https://hexdocs.pm/hackney/hackney_url.html): Module to parse and create URIs.
50+
- [`hackney_date`](https://hexdocs.pm/hackney/hackney_date.html): Module to parse HTTP dates.
5151

52-
Read the [NEWS](https://raw.github.com/benoitc/hackney/master/NEWS.md) file
52+
Read the [NEWS](https://hexdocs.pm/hackney/news.html) file
5353
to get the last changelog.
5454

5555
## Installation

rebar.config

+20-13
Original file line numberDiff line numberDiff line change
@@ -30,23 +30,30 @@
3030
{unicode_util_compat, "~>0.7.0"}
3131
]}.
3232

33-
{profiles, [{docs, [{deps,
34-
[
35-
{edown,
36-
{git, "https://github.com/uwiger/edown.git",
37-
{tag, "0.8.4"}}}
38-
]},
39-
40-
{edoc_opts, [{doclet, edown_doclet},
41-
{packages, false},
42-
{subpackages, true},
43-
{top_level_readme,
44-
{"./README.md", "http://github.com/benoitc/hackney"}}]}]},
45-
{test, [
33+
{profiles, [{test, [
4634
{deps, [{cowboy, "1.1.2"}, {jsone, "1.4.7"}]}
4735
]}
4836
]}.
4937

38+
{hex, [
39+
{doc, #{provider => ex_doc}}
40+
]}.
41+
42+
43+
44+
{project_plugins, [rebar3_ex_doc]}.
45+
46+
{ex_doc, [
47+
{extras, [
48+
{"README.md", #{title => "Overview"}},
49+
{"NEWS.md", #{title => "Changelog"}},
50+
{"LICENSE", #{title => "License"}},
51+
{"NOTICE", #{title => "Notice"}}
52+
]},
53+
{main, "README.md"},
54+
{source_url, "https://github.com/benoitc/hackney"},
55+
{source_ref, <<"master">>}
56+
]}.
5057

5158
%% == Dialyzer ==
5259
%%

src/hackney.app.src

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
{application, hackney,
55
[
66
{description, "simple HTTP client"},
7-
{vsn, "1.21.0"},
7+
{vsn, "1.22.0"},
88
{registered, [hackney_pool]},
99
{applications, [kernel,
1010
stdlib,

0 commit comments

Comments
 (0)