From: Tom Christie <tom@tomchristie.com>
Date: Wed, 12 Jun 2019 15:06:09 +0000 (+0100)
Subject: Docs tweaks
X-Git-Tag: 0.5.0~14
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=60dca3da396e94b1c926662dd63b170026dd3685;p=thirdparty%2Fhttpx.git

Docs tweaks
---

diff --git a/README.md b/README.md
index 09c380c7..2c5bb32c 100644
--- a/README.md
+++ b/README.md
@@ -61,6 +61,16 @@ Plus all the standard features of `requests`...
 * .netrc Support *TODO*
 * Chunked Requests
 
+## Installation
+
+Install with pip:
+
+```shell
+$ pip install http3
+```
+
+HTTP3 requires Python 3.6+
+
 ## Documentation
 
 For a run-through of all the basics, head over to the [QuickStart](quickstart.md).
@@ -84,3 +94,6 @@ The HTTP3 project relies on these excellent libraries:
 A huge amount of credit is due to `requests` for the API layout that
 much of this work follows, as well as to `urllib3` for plenty of design
 inspiration around the lower level networking details.
+
+<p align="center">&mdash; ⭐️ &mdash;</p>
+<p align="center"><i>HTTP3 is <a href="https://github.com/encode/http3/blob/master/LICENSE.md">BSD licensed</a> code. Designed & built in Brighton, England.</i></p>
diff --git a/docs/index.md b/docs/index.md
index 41c8ee90..b4c7f016 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,4 +1,4 @@
-# HTTP3
+<h1 style="margin: 0">HTTP3</h1>
 
 <a href="https://travis-ci.org/encode/http3">
     <img src="https://travis-ci.org/encode/http3.svg?branch=master" alt="Build Status">
@@ -86,3 +86,13 @@ The HTTP3 project relies on these excellent libraries:
 A huge amount of credit is due to `requests` for the API layout that
 much of this work follows, as well as to `urllib3` for plenty of design
 inspiration around the lower level networking details.
+
+## Installation
+
+Install with pip:
+
+```shell
+$ pip install http3
+```
+
+HTTP3 requires Python 3.6+
diff --git a/docs/parallel.md b/docs/parallel.md
index 66d84905..f86fb705 100644
--- a/docs/parallel.md
+++ b/docs/parallel.md
@@ -1,5 +1,10 @@
 # Parallel Requests
 
+!!! warning
+    This page documents some proposed functionality that is not yet released.
+    See [pull request #52](https://github.com/encode/http3/pull/52) for the
+    first-pass of an implementation.
+
 HTTP3 allows you to make HTTP requests in parallel in a highly efficient way,
 using async under the hood, while still presenting a standard threaded interface.