From 1889680fd03fd53524c726f3e7e2d90d36fa9567 Mon Sep 17 00:00:00 2001 From: Andrew Godwin Date: Sat, 2 Jan 2016 18:48:53 -0800 Subject: [PATCH] Update README --- README.rst | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 8082920..640063f 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,17 @@ daphne ====== -Daphne is a HTTP, HTTP2 and WebSocket interface server for Django. +Daphne is a HTTP, HTTP2 and WebSocket protocol server for +`ASGI `_, and developed +to power Django Channels. + +It supports automatic negotiation of protocols; there's no need for URL +prefixing to determine WebSocket endpoints versus HTTP endpoints. + +Running +------- + +Simply point Daphne to your ASGI channel layer instance, and optionally +set a bind address and port (defaults to localhost, port 8000):: + + daphne -b 0.0.0.0 -p 8001 django_project.asgi.channel_layer