Merge pull request #9 from mbildner/patch-1

kennethreitz · kennethreitz · commit 6dc512a7a058 · 2013-11-25T11:31:43.000-08:00
Updates README.md to warn against using Flask dev server
diff --git a/README.rst b/README.rst
@@ -44,10 +44,26 @@ A custom Gunicorn worker is included to make deployment as friendly as possible:
 Production services are provided by `gevent <http://www.gevent.org>`_
 and `gevent-websocket <http://www.gelens.org/code/gevent-websocket/>`_.
 
+
 Anything that inserts ``wsgi.websocket`` into the WSGI environ is
 supported, but gevent-websocket is recommended.
 
 
+Development / Testing
+---------------------
+
+Because the Werkzeug development server cannot provide the WSGI environ with 
+a websocket interface, it is not possible to run a Flask app using the standard 
+``app.run()``.  
+
+If you try to, Flask will still try to serve on all the specified routes, and 
+throw a ``KeyError`` whenever a client tries to connect to a websocket route.  
+
+Instead, just use the included gunicorn worker (explained above), or anything that
+can insert ``wsgi.websocket`` into the WSGI environ.
+
+
+
 WebSocket Interface
 -------------------
 
