aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoradamw <adam@warski.org>2017-08-02 12:08:32 +0200
committeradamw <adam@warski.org>2017-08-02 12:08:32 +0200
commit02be9a13bf6e4a6da8a5ced85ae6b716a64c919a (patch)
tree70fe587146ab77214c47444809af9cf4564728b6 /README.md
parent284860a8506589b19ca1afd2a33cecb45747f340 (diff)
downloadsttp-02be9a13bf6e4a6da8a5ced85ae6b716a64c919a.tar.gz
sttp-02be9a13bf6e4a6da8a5ced85ae6b716a64c919a.tar.bz2
sttp-02be9a13bf6e4a6da8a5ced85ae6b716a64c919a.zip
OkHttp docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
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).