Skip to content

Commit e1dcf80

Browse files
committed
Specify that a real provider is highly recommended + jars
1 parent 9ac7884 commit e1dcf80

File tree

1 file changed

+42
-8
lines changed

1 file changed

+42
-8
lines changed

README.md

Lines changed: 42 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,61 @@ Async Http Client
33

44
[Javadoc](http://www.javadoc.io/doc/com.ning/async-http-client/)
55

6-
Getting started [HTML](https://asynchttpclient.github.io/async-http-client/),
7-
with [WebSockets](http://jfarcand.wordpress.com/2011/12/21/writing-websocket-clients-using-asynchttpclient/)
6+
[Getting](https://jfarcand.wordpress.com/2010/12/21/going-asynchronous-using-asynchttpclient-the-basic/) [started](https://jfarcand.wordpress.com/2011/01/04/going-asynchronous-using-asynchttpclient-the-complex/), and use [WebSockets](http://jfarcand.wordpress.com/2011/12/21/writing-websocket-clients-using-asynchttpclient/)
87

9-
Async Http Client library purpose is to allow Java applications to easily execute HTTP requests and asynchronously process the HTTP responses. The library also supports the WebSocket Protocol. The Async HTTP Client library is simple to use. First, in order to add it to your Maven project, simply add this dependency:
8+
Async Http Client library purpose is to allow Java applications to easily execute HTTP requests and asynchronously process the HTTP responses.
9+
The library also supports the WebSocket Protocol. The Async HTTP Client library is simple to use.
10+
11+
## Installation
12+
13+
First, in order to add it to your Maven project, simply add this dependency:
1014

1115
```xml
1216
<dependency>
1317
<groupId>com.ning</groupId>
1418
<artifactId>async-http-client</artifactId>
15-
<version>1.9.24</version>
19+
<version>1.9.25</version>
1620
</dependency>
1721
```
1822

19-
Check [migration guide](MIGRATION.md) for migrating from 1.8 to 1.9.
20-
2123
You can also download the artifact
2224

2325
[Maven Search](http://search.maven.org)
2426

27+
AHC is an abstraction layer that can work on top of the bare JDK, Netty and Grizzly.
28+
Note that the JDK implementation is very limited and you should **REALLY** use the other *real* providers.
29+
30+
You then have to add the Netty or Grizzly jars in the classpath.
31+
32+
For Netty:
33+
34+
```xml
35+
<dependency>
36+
<groupId>io.netty</groupId>
37+
<artifactId>netty</artifactId>
38+
<version>LATEST_NETTY_3_VERSION</version>
39+
</dependency>
40+
```
41+
42+
For Grizzly:
43+
44+
```xml
45+
<dependency>
46+
<groupId>org.glassfish.grizzly</groupId>
47+
<artifactId>connection-pool</artifactId>
48+
<version>LATEST_GRIZZLY_VERSION</version>
49+
</dependency>
50+
<dependency>
51+
<groupId>org.glassfish.grizzly</groupId>
52+
<artifactId>grizzly-websockets</artifactId>
53+
<version>LATEST_GRIZZLY_VERSION</version>
54+
</dependency>
55+
```
56+
57+
Check [migration guide](MIGRATION.md) for migrating from 1.8 to 1.9.
58+
59+
## Usage
60+
2561
Then in your code you can simply do
2662

2763
```java
@@ -189,8 +225,6 @@ Keep up to date on the library development by joining the Asynchronous HTTP Clie
189225

190226
[Google Group](http://groups.google.com/group/asynchttpclient)
191227

192-
[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/6433679063b2351599c6ca44a08246a2 "githalytics.com")](http://githalytics.com/AsyncHttpClient/async-http-client)
193-
194228
## Contributing
195229

196230
Of course, Pull Requests are welcome.

0 commit comments

Comments
 (0)