aboutsummaryrefslogtreecommitdiff
path: root/docs/backends/okhttp.rst
diff options
context:
space:
mode:
authoradamw <adam@warski.org>2017-10-12 19:23:09 +0200
committeradamw <adam@warski.org>2017-10-12 19:23:09 +0200
commit7bf4d02da823c21b27cf20ba0b764b511ac69432 (patch)
tree04b9ab557c4af82b9970af386e6f4f9e4292e472 /docs/backends/okhttp.rst
parent7885188a982c193e26f8ca6bc9aea8f6a642b32d (diff)
downloadsttp-7bf4d02da823c21b27cf20ba0b764b511ac69432.tar.gz
sttp-7bf4d02da823c21b27cf20ba0b764b511ac69432.tar.bz2
sttp-7bf4d02da823c21b27cf20ba0b764b511ac69432.zip
More docs
Diffstat (limited to 'docs/backends/okhttp.rst')
-rw-r--r--docs/backends/okhttp.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/backends/okhttp.rst b/docs/backends/okhttp.rst
new file mode 100644
index 0000000..52fbc49
--- /dev/null
+++ b/docs/backends/okhttp.rst
@@ -0,0 +1,17 @@
+``OkHttpClientBackend``
+=======================
+
+To use, add the following dependency to your project::
+
+ "com.softwaremill.sttp" %% "okhttp-backend" % "0.0.20"
+ // or, for the monix version:
+ "com.softwaremill.sttp" %% "okhttp-backend-monix" % "0.0.20"
+
+This backend depends on `OkHttp <http://square.github.io/okhttp/>`_, and offers:
+
+* a **synchronous** backend: ``OkHttpSyncBackend``
+* an **asynchronous**, ``Future``-based backend: ``OkHttpFutureBackend``
+* an **asynchronous**, Monix-``Task``-based backend: ``OkHttpMonixBackend``
+
+OkHttp fully supports HTTP/2.
+