summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoel Martin <github@martintribe.org>2013-03-12 13:46:45 -0500
committerJoel Martin <github@martintribe.org>2013-03-12 13:46:45 -0500
commitdb6a7e3e28cd4631d4db8a9ac240a0041d938d60 (patch)
treebfea3e0633c9db8571e02ed345535de18b4c4373 /README.md
parentd9aedfe7d3453e358b28c2feceb3bfa52895d404 (diff)
downloadwebsockify-db6a7e3e28cd4631d4db8a9ac240a0041d938d60.tar.gz
Update to version 0.4.1v0.4.1
*** IMPORTANT NOTE *** 0.4.X is the last minor version to support the Hixie protocol. 0.5.0 will drop the Hixie protocol support. The latest released version of all major browsers (and web-socket-js) support the IETF 6455 protocol. - Other changes: add 'include/' sub-dir to source distribution and to installed packaged.
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 9 insertions, 8 deletions
diff --git a/README.md b/README.md
index 2cfac0f..1e91910 100644
--- a/README.md
+++ b/README.md
@@ -10,14 +10,15 @@ the target in both directions.
### WebSockets binary data
-Websockify supports all versions of the WebSockets protocol (Hixie and
-HyBi). The older Hixie versions of the protocol only support UTF-8
-text payloads. In order to transport binary data over UTF-8 an
-encoding must used to encapsulate the data within UTF-8.
-
-With Hixie clients, Websockify uses base64 to encode all traffic to
-and from the client. This does not affect the data between websockify
-and the server.
+Websockify 0.4.X supports all versions of the WebSockets protocol
+(Hixie and HyBi). Starting with websockify 0.5.0, only the HyBi / IETF
+6455 WebSocket protocol is supported.
+
+The older Hixie versions of the protocol only support UTF-8 text
+payloads. In order to transport binary data over UTF-8 an encoding
+must used to encapsulate the data within UTF-8. With Hixie clients,
+Websockify uses base64 to encode all traffic to and from the client.
+This does not affect the data between websockify and the server.
With HyBi clients, websockify negotiates whether to base64 encode
traffic to and from the client via the subprotocol header