Mention the Requests transport adapter.

Author: Lukasa

HISTORY.rst

@@ -11,12 +11,16 @@ X.X.X (XXXX-XX-XX)
   (`Issue #16`_)
 - `HTTP20Connection` objects are now context managers. (`Issue #13`_)
 - Response bodies are automatically decompressed. (`Issue #20`_)
+- Provide a requests transport adapter. (`Issue #19`_)
+- Fix the build status indicator. (`Issue #22`_)
 
 
 .. _Issue #12: https://github.com/Lukasa/hyper/issues/12
 .. _Issue #16: https://github.com/Lukasa/hyper/issues/16
 .. _Issue #13: https://github.com/Lukasa/hyper/issues/13
 .. _Issue #20: https://github.com/Lukasa/hyper/issues/20
+.. _Issue #19: https://github.com/Lukasa/hyper/issues/19
+.. _Issue #22: https://github.com/Lukasa/hyper/issues/22
 
 0.0.1 (2014-02-11)
 ++++++++++++++++++

docs/source/quickstart.rst

@@ -99,3 +99,35 @@ For example::
     >>> third_response = c.getresponse(third)
 
 ``hyper`` will ensure that each response is matched to the correct request.
+
+Requests Integration
+--------------------
+
+Do you like `requests`_? Of course you do, everyone does! It's a shame that
+requests doesn't support HTTP/2.0 though. To rectify that oversight, ``hyper``
+provides a transport adapter that can be plugged directly into Requests, giving
+it instant HTTP/2.0 support.
+
+All you have to do is identify a host that you'd like to communicate with over
+HTTP/2.0. Once you've worked that out, you can get started straight away::
+
+    >>> import requests
+    >>> from hyper.contrib import HTTP20Adapter
+    >>> s = requests.Session()
+    >>> s.mount('https://twitter.com', HTTP20Adapter())
+    >>> r = s.get('https://twitter.com')
+    >>> print(r.status_code)
+    200
+
+This transport adapter is subject to all of the limitations that apply to
+``hyper``, and provides all of the goodness of requests.
+
+A quick warning: some hosts will redirect to new hostnames, which may redirect
+you away from HTTP/2.0. Make sure you install the adapter for all the hostnames
+you're interested in::
+
+    >>> a = HTTP20Adapter()
+    >>> s.mount('https://twitter.com', a)
+    >>> s.mount('https://www.twitter.com', a)
+
+.. _requests: http://python-requests.org/