Skip to content

Commit 5eeec34

Browse files
authored
Add installation instructions to readme. (#282)
1 parent 1132fcc commit 5eeec34

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@ There are two available implementations:
1919

2020
Both layers support a single-server and sharded configurations.
2121

22+
Installation
23+
------------
24+
25+
.. code-block::
26+
27+
pip install channels-redis
28+
2229
**Note:** Prior versions of this package were called ``asgi_redis`` and are
2330
still available under PyPI as that name if you need them for Channels 1.x projects.
2431
This package is for Channels 2 projects only.
@@ -29,6 +36,8 @@ Usage
2936

3037
Set up the channel layer in your Django settings file like so::
3138

39+
.. code-block:: python
40+
3241
CHANNEL_LAYERS = {
3342
"default": {
3443
"BACKEND": "channels_redis.core.RedisChannelLayer",
@@ -40,6 +49,8 @@ Set up the channel layer in your Django settings file like so::
4049
4150
Or, you can use the alternate implementation which uses Redis Pub/Sub::
4251

52+
.. code-block:: python
53+
4354
CHANNEL_LAYERS = {
4455
"default": {
4556
"BACKEND": "channels_redis.pubsub.RedisPubSubChannelLayer",

0 commit comments

Comments
 (0)