From 3cb459d56daeae8fd2b923c27f39ca5595a50e7b Mon Sep 17 00:00:00 2001
From: Thomas Kriechbaumer <thomas@kriechbaumer.name>
Date: Thu, 17 Aug 2017 10:18:05 +0200
Subject: docs++: add individual protocol pages

---
 docs/protocols/websocket.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 docs/protocols/websocket.rst

(limited to 'docs/protocols/websocket.rst')

diff --git a/docs/protocols/websocket.rst b/docs/protocols/websocket.rst
new file mode 100644
index 00000000..85cff3ac
--- /dev/null
+++ b/docs/protocols/websocket.rst
@@ -0,0 +1,17 @@
+.. _websocket_protocol:
+
+WebSocket
+=========
+
+.. seealso::
+
+    - `RFC6455: The WebSocket Protocol <http://tools.ietf.org/html/rfc6455>`_
+    - `RFC7692: Compression Extensions for WebSocket <http://tools.ietf.org/html/rfc7692>`_
+
+WebSocket support in mitmproxy is based on the amazing work by the python-hyper
+community with the `wsproto <https://github.com/python-hyper/wsproto>`_
+project. It fully encapsulates WebSocket frames/messages/connections and
+provides an easy-to-use event-based API.
+
+mitmproxy fully supports the compression extension for WebSocket messages,
+provided by wsproto.
-- 
cgit v1.2.3