From 766ae09c3b02157235f899bfb1f5298b029b97e5 Mon Sep 17 00:00:00 2001 From: Jakob Bowyer Date: Thu, 2 Mar 2017 15:24:29 +0000 Subject: [PATCH] Updated README with install instructions --- README.rst | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 3f565f71..ba8ebd1b 100644 --- a/README.rst +++ b/README.rst @@ -57,7 +57,22 @@ Hello World Example Installation ------------ -- ``python -m pip install sanic`` +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 :(