aboutsummaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authoradamw <adam@warski.org>2017-10-17 17:28:50 +0200
committeradamw <adam@warski.org>2017-10-17 17:28:50 +0200
commit6e109a964383bfe5e2be04f65fa7cc1356a97cbe (patch)
tree7764ff94d72e0ffbf1e593fb8c5886562dc57f33 /docs/index.rst
parent06bd5c95d04dd57e1b6c2572b94336b8fdb68bfa (diff)
downloadsttp-6e109a964383bfe5e2be04f65fa7cc1356a97cbe.tar.gz
sttp-6e109a964383bfe5e2be04f65fa7cc1356a97cbe.tar.bz2
sttp-6e109a964383bfe5e2be04f65fa7cc1356a97cbe.zip
More docs
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst77
1 files changed, 43 insertions, 34 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 0550cd7..d569a11 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,12 +1,11 @@
sttp: the Scala HTTP client you always wanted!
==============================================
-`sttp <https://github.com/softwaremill/sttp>`_ is an open-source library which provides a clean, programmer-friendly API to define HTTP requests and execute them using one of the wrapped backends, such as `akka-http <https://doc.akka.io/docs/akka-http/current/scala/http/>`_, `async-http-client <https://github.com/AsyncHttpClient/async-http-client>`_ or `OkHttp <http://square.github.io/okhttp/>`_.
+Welcome!
-First impressions
------------------
+`sttp <https://github.com/softwaremill/sttp>`_ is an open-source library which provides a clean, programmer-friendly API to define HTTP requests and execute them using one of the wrapped backends, such as `akka-http <https://doc.akka.io/docs/akka-http/current/scala/http/>`_, `async-http-client <https://github.com/AsyncHttpClient/async-http-client>`_ or `OkHttp <http://square.github.io/okhttp/>`_.
-.. code-block:: scala
+Here's a very quick example of sttp in action::
import com.softwaremill.sttp._
@@ -25,38 +24,42 @@ First impressions
// response.unsafeBody: by default read into a String
println(response.unsafeBody)
-
-
-Quickstart with Ammonite
-------------------------
-
-If you are an `Ammonite <http://ammonite.io>`_ user, you can quickly start
-experimenting with sttp by copy-pasting the following::
-
- import $ivy.`com.softwaremill.sttp::core:0.0.20`
- import com.softwaremill.sttp._
- implicit val backend = HttpURLConnectionBackend()
- sttp.get(uri"http://httpbin.org/ip").send()
-
-Adding sttp to your project
----------------------------
-The basic dependency which provides the default, synchornous backend is::
+For more details, explore the subjects below!
- "com.softwaremill.sttp" %% "core" % "0.0.20"
-
-``sttp`` is available for Scala 2.11 and 2.12, and requires Java 7 if using an ``OkHttp`` based backend, or Java 8 otherwise. The core module has no transitive dependencies.
+.. toctree::
+ :maxdepth: 2
+ :caption: Getting started
-If you'd like to use an alternate backend, [see below](#supported-backends) for additional instructions.
+ quickstart
+ goals
+ community
.. toctree::
:maxdepth: 2
+ :caption: Request definition
- goals
requests/basics
requests/uri
- requests/defaults
+ requests/headers
+ requests/cookies
+ requests/authentication
+ requests/body
+ requests/multipart
+ requests/streaming
requests/type
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Responses
+
+ responses/basics
+ responses/body
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Backends
+
backends/summary
backends/start_stop
backends/httpurlconnection
@@ -64,17 +67,23 @@ If you'd like to use an alternate backend, [see below](#supported-backends) for
backends/asynchttpclient
backends/okhttp
backends/custom
+ backends/testing
+ backends/tagging
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Configuration
+
conf/timeouts
conf/ssl
- conf/proxy
+ conf/proxy
+ conf/redirects
+
+.. toctree::
+ :maxdepth: 2
+ :caption: More information
+
json
- testing
other
credits
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`