Updated README with install instructions
This commit is contained in:
parent
5f140048f4
commit
766ae09c3b
16
README.rst
16
README.rst
|
@ -57,8 +57,23 @@ Hello World Example
|
||||||
Installation
|
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``
|
- ``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
|
Documentation
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
|
@ -79,6 +94,7 @@ TODO
|
||||||
----
|
----
|
||||||
* Streamed file processing
|
* Streamed file processing
|
||||||
* http2
|
* http2
|
||||||
|
|
||||||
Limitations
|
Limitations
|
||||||
-----------
|
-----------
|
||||||
* No wheels for uvloop and httptools on Windows :(
|
* No wheels for uvloop and httptools on Windows :(
|
||||||
|
|
Loading…
Reference in New Issue
Block a user