]> git.ipfire.org Git - thirdparty/httpx.git/commitdiff
Docs tweaks
authorTom Christie <tom@tomchristie.com>
Wed, 12 Jun 2019 15:06:09 +0000 (16:06 +0100)
committerTom Christie <tom@tomchristie.com>
Wed, 12 Jun 2019 15:06:09 +0000 (16:06 +0100)
README.md
docs/index.md
docs/parallel.md

index 09c380c7a1ba4bde7e930a750f1567bffa72b039..2c5bb32c5606070a4beede0c64d8ef9ef8899b8f 100644 (file)
--- 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>
index 41c8ee9054380390b7e7c06f2eb8dfddebeaac09..b4c7f016e402d6a5145e87835dc4c81cd233390a 100644 (file)
@@ -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+
index 66d84905a77360a233a4a47232d22afb44638e2b..f86fb705da5a8ee2bf5ea9f92c56ef4383ead513 100644 (file)
@@ -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.