From 02be9a13bf6e4a6da8a5ced85ae6b716a64c919a Mon Sep 17 00:00:00 2001 From: adamw Date: Wed, 2 Aug 2017 12:08:32 +0200 Subject: OkHttp docs --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 5e091f4..0d0065d 100644 --- a/README.md +++ b/README.md @@ -184,6 +184,8 @@ uri"$scheme://$subdomains.example.com?x=$vx&$params#$jumpTo" | `FutureAsyncHttpClientHandler` | `scala.concurrent.Future` | - | | `ScalazAsyncHttpClientHandler` | `scalaz.concurrent.Task` | - | | `MonixAsyncHttpClientHandler` | `monix.eval.Task` | `monix.reactive.Observable[ByteBuffer]` | +| `OkHttpSyncClientHandler` | None (`Id`) | - | +| `OkHttpFutureClientHandler` | `scala.concurrent.Future` | - | ### `HttpURLConnectionSttpHandler` @@ -336,6 +338,18 @@ val response: Task[Response[Observable[ByteBuffer]]] = .send() ``` +### `OkHttpClientHandler` + +To use, add the following dependency to your project: + +```scala +"com.softwaremill.sttp" %% "okhttp-client-handler" % "0.0.3" +``` + +This handler depends on [OkHttp](http://square.github.io/okhttp/), and offers +both a **synchronous** (`OkHttpSyncClientHandler`) and **asynchronous** +(`OkHttpFutureClientHandler`), `Future`-based handlers. + ## Request type All request descriptions have type `RequestT[U, T, S]` (T as in Template). -- cgit v1.2.3