Skip to content

Commit

Permalink
Updates to readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
JakeWharton committed May 4, 2013
1 parent 3bbe04a commit 8c3811d
Showing 1 changed file with 20 additions and 9 deletions.
29 changes: 20 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,11 @@ An HTTP+SPDY client for Android and Java applications.
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][1] or grab via Maven:

```xml
<dependency>
<groupId>com.squareup</groupId>
<groupId>com.squareup.okhttp</groupId>
<artifactId>okhttp</artifactId>
<version>(insert latest version)</version>
</dependency>
Expand All @@ -23,22 +21,32 @@ You can also depend on the .jar through Maven:
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 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.
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.

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
Expand Down Expand Up @@ -67,5 +75,8 @@ License



[1]: http://github.com/square/okhttp/downloads

[1]: http://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.squareup.okhttp&a=okhttp&v=LATEST
[2]: http://developer.android.com/reference/java/net/ProxySelector.html
[3]: http://wiki.eclipse.org/Jetty/Feature/NPN
[4]: https://code.google.com/p/vogar/

0 comments on commit 8c3811d

Please sign in to comment.