diff --git a/README.rst b/README.rst index 941179a7..e46b466e 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,4 @@ -.. image:: https://raw.githubusercontent.com/huge-success/sanic-assets/master/png/sanic-framework-logo-400x97.png +.. image:: https://raw.githubusercontent.com/sanic-org/sanic-assets/master/png/sanic-framework-logo-400x97.png :alt: Sanic | Build fast. Run fast. Sanic | Build fast. Run fast. @@ -24,12 +24,12 @@ Sanic | Build fast. Run fast. :target: https://community.sanicframework.org/ .. |Join the chat at https://gitter.im/sanic-python/Lobby| image:: https://badges.gitter.im/sanic-python/Lobby.svg :target: https://gitter.im/sanic-python/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge -.. |Codecov| image:: https://codecov.io/gh/huge-success/sanic/branch/master/graph/badge.svg - :target: https://codecov.io/gh/huge-success/sanic -.. |Build Status| image:: https://travis-ci.com/huge-success/sanic.svg?branch=master - :target: https://travis-ci.com/huge-success/sanic +.. |Codecov| image:: https://codecov.io/gh/sanic-org/sanic/branch/master/graph/badge.svg + :target: https://codecov.io/gh/sanic-org/sanic +.. |Build Status| image:: https://travis-ci.com/sanic-org/sanic.svg?branch=master + :target: https://travis-ci.com/sanic-org/sanic .. |AppVeyor Build Status| image:: https://ci.appveyor.com/api/projects/status/d8pt3ids0ynexi8c/branch/master?svg=true - :target: https://ci.appveyor.com/project/huge-success/sanic + :target: https://ci.appveyor.com/project/sanic-org/sanic .. |Documentation| image:: https://readthedocs.org/projects/sanic/badge/?version=latest :target: http://sanic.readthedocs.io/en/latest/?badge=latest .. |PyPI| image:: https://img.shields.io/pypi/v/sanic.svg @@ -50,6 +50,9 @@ Sanic | Build fast. Run fast. .. |Downloads| image:: https://pepy.tech/badge/sanic/month :alt: Downloads :target: https://pepy.tech/project/sanic +.. |Downloads| image:: https://pepy.tech/badge/sanic/week + :alt: Downloads + :target: https://pepy.tech/project/sanic .. |Conda downloads| image:: https://img.shields.io/conda/dn/conda-forge/sanic.svg :alt: Downloads :target: https://anaconda.org/conda-forge/sanic @@ -60,7 +63,7 @@ Sanic is a **Python 3.6+** web server and web framework that's written to go fas Sanic is also ASGI compliant, so you can deploy it with an `alternative ASGI webserver `_. -`Source code on GitHub `_ | `Help and discussion board `_. +`Source code on GitHub `_ | `Help and discussion board `_. The project is maintained by the community, for the community. **Contributions are welcome!** @@ -72,11 +75,11 @@ Installation ``pip3 install sanic`` Sanic makes use of ``uvloop`` and ``ujson`` to help with performance. If you do not want to use those packages, simply add an environmental variable ``SANIC_NO_UVLOOP=true`` or ``SANIC_NO_UJSON=true`` at install time. - + .. code:: shell - + $ export SANIC_NO_UVLOOP=true - $ export SANIC_NO_UJSON=true + $ export SANIC_NO_UJSON=true $ pip3 install --no-binary :all: sanic @@ -87,7 +90,7 @@ Installation .. note:: - Windows support is currently "experimental" and on a best-effort basis. Multiple workers are also not currently supported on Windows (see `Issue #1517 `_), but setting ``workers=1`` should launch the server successfully. + Windows support is currently "experimental" and on a best-effort basis. Multiple workers are also not currently supported on Windows (see `Issue #1517 `_), but setting ``workers=1`` should launch the server successfully. Hello World Example ------------------- @@ -105,7 +108,7 @@ Hello World Example if __name__ == '__main__': app.run(host='0.0.0.0', port=8000) - + Sanic can now be easily run using ``sanic hello.app``. .. code:: @@ -124,7 +127,7 @@ And, we can verify it is working: ``curl localhost:8000 -i`` Content-Type: application/json {"hello":"world"} - + **Now, let's go build something fast!** @@ -136,9 +139,9 @@ Documentation Changelog --------- -`Release Changelogs `_. +`Release Changelogs `_. + - Questions and Discussion ------------------------ @@ -147,4 +150,4 @@ Questions and Discussion Contribution ------------ -We are always happy to have new contributions. We have `marked issues good for anyone looking to get started `_, and welcome `questions on the forums `_. Please take a look at our `Contribution guidelines `_. +We are always happy to have new contributions. We have `marked issues good for anyone looking to get started `_, and welcome `questions on the forums `_. Please take a look at our `Contribution guidelines `_.