mirror of
https://github.com/django/daphne.git
synced 2025-07-11 08:22:17 +03:00
Tidy up main README a bit more
This commit is contained in:
parent
971d3fc8d0
commit
f79ecbff6d
26
README.rst
26
README.rst
|
@ -13,16 +13,14 @@ Django Channels
|
||||||
.. image:: https://img.shields.io/pypi/l/channels.svg
|
.. image:: https://img.shields.io/pypi/l/channels.svg
|
||||||
:target: https://pypi.python.org/pypi/channels
|
:target: https://pypi.python.org/pypi/channels
|
||||||
|
|
||||||
*(Note: Recent versions of Channels also need recent versions of Daphne,
|
Channels loads into Django as a pluggable app to bring WebSocket, long-poll HTTP,
|
||||||
asgi_redis and asgiref, so make sure you update all at once)*
|
task offloading and other asynchrony support to your code, using familiar Django
|
||||||
|
design patterns and a flexible underlying framework that lets you not only
|
||||||
This is a work-in-progress code branch of Django implemented as a third-party
|
customize behaviours but also write support for your own protocols and needs.
|
||||||
app, which aims to bring some asynchrony to Django and expand the options
|
|
||||||
for code beyond the request-response model, in particular enabling WebSocket,
|
|
||||||
HTTP2 push, and background task support.
|
|
||||||
|
|
||||||
This is still **beta** software: the API is mostly settled, but might change
|
This is still **beta** software: the API is mostly settled, but might change
|
||||||
a bit as things develop.
|
a bit as things develop. Once we hit ``1.0``, it will be stablized and a
|
||||||
|
deprecation policy will come in.
|
||||||
|
|
||||||
Documentation, installation and getting started instructions are at
|
Documentation, installation and getting started instructions are at
|
||||||
http://channels.readthedocs.org
|
http://channels.readthedocs.org
|
||||||
|
@ -30,8 +28,16 @@ http://channels.readthedocs.org
|
||||||
Support can be obtained either here via issues, or in the ``#django-channels``
|
Support can be obtained either here via issues, or in the ``#django-channels``
|
||||||
channel on Freenode.
|
channel on Freenode.
|
||||||
|
|
||||||
You can also install channels from PyPI as the ``channels`` package.
|
You can install channels from PyPI as the ``channels`` package.
|
||||||
You'll likely also want ``asgi_redis`` to provide the Redis channel layer.
|
You'll likely also want to ``asgi_redis`` to provide the Redis channel layer.
|
||||||
|
See our `installation <http://channels.readthedocs.io/en/latest/installation.html>`_
|
||||||
|
and `getting started <http://channels.readthedocs.io/en/latest/getting-started.html>`_ docs for more.
|
||||||
|
|
||||||
|
|
||||||
|
Contributing
|
||||||
|
------------
|
||||||
|
|
||||||
|
To learn more about contributing, please `read our contributing docs <http://channels.readthedocs.io/en/latest/contributing.html>`_.
|
||||||
|
|
||||||
|
|
||||||
Maintenance and Security
|
Maintenance and Security
|
||||||
|
|
Loading…
Reference in New Issue
Block a user