Updated README with install instructions

2017-03-02 15:24:29 +00:00 · 2017-03-02 15:24:29 +00:00 · 766ae09c3b
commit 766ae09c3b
parent 5f140048f4
1 changed files with 17 additions and 1 deletions
--- a/README.rst
+++ b/README.rst
@ -57,8 +57,23 @@ Hello World Example
 Installation
 ------------

+The base install of sanic does not come with uvloop and ujson as they are not needed to get running,
+they do however provide sutible speedups so to install sanic with all the extensions use 
+
+-  ``python -m pip install sanic["all"]``
+
+To install sanic without uvloop or ujson then use
+
 - ``python -m pip install sanic``

+Otherwise specify specific support by naming the extension you want included
+
+- ``python -m pip install sanic["ujson"]``
+
+or 
+
+- ``python -m pip install sanic["uvloop"]``
+
 Documentation
 -------------

@ -79,6 +94,7 @@ TODO
 ----
 * Streamed file processing
 * http2
+
 Limitations
 -----------
 * No wheels for uvloop and httptools on Windows :(