diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 39 |
1 files changed, 22 insertions, 17 deletions
@@ -1,44 +1,46 @@ OkHttp ====== -An HTTP+SPDY client for Android and Java applications. +An HTTP & SPDY client for Android and Java applications. + +For more information please see [the website][1]. + Download -------- -Downloadable .jars can be found on the [GitHub download page][1]. - -You can also depend on the .jar through Maven: +Download [the latest JAR][2] or grab via Maven: ```xml <dependency> - <groupId>com.squareup</groupId> + <groupId>com.squareup.okhttp</groupId> <artifactId>okhttp</artifactId> <version>(insert latest version)</version> </dependency> ``` -Known Issues ------------- - -OkHttp uses the platform's [ProxySelector][2]. Prior to Android 4.0, `ProxySelector` didn't honor the `proxyHost` and `proxyPort` system properties for HTTPS connections. Work around this by specifying the `https.proxyHost` and `https.proxyPort` system properties when using a proxy with HTTPS. - -OkHttp's test suite creates an in-process HTTPS server. Prior to Android 2.3, SSL server sockets were broken, and so HTTPS tests will time out when run on such devices. - - Building -------- ### On the Desktop -Run OkHttp tests on the desktop with Maven. Running SPDY tests on the desktop uses [Jetty-NPN](http://wiki.eclipse.org/Jetty/Feature/NPN) which requires OpenJDK 7+. + +Run OkHttp tests on the desktop with Maven. Running SPDY tests on the desktop uses +[Jetty-NPN][3] which requires OpenJDK 7+. + ``` mvn clean test ``` ### On a Device -Test on a USB-attached Android using [Vogar](https://code.google.com/p/vogar/). Unfortunately `dx` requires that you build with Java 6, otherwise the test class will be silently omitted from the `.dex` file. + +OkHttp's test suite creates an in-process HTTPS server. Prior to Android 2.3, SSL server sockets +were broken, and so HTTPS tests will time out when run on such devices. + +Test on a USB-attached Android using [Vogar][4]. Unfortunately `dx` requires that you build with +Java 6, otherwise the test class will be silently omitted from the `.dex` file. + ``` mvn clean mvn package -DskipTests @@ -67,5 +69,8 @@ License - [1]: http://github.com/square/okhttp/downloads - [2]: http://developer.android.com/reference/java/net/ProxySelector.html + + [1]: http://square.github.io/okhttp + [2]: http://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.squareup.okhttp&a=okhttp&v=LATEST + [3]: http://wiki.eclipse.org/Jetty/Feature/NPN + [4]: https://code.google.com/p/vogar/ |