aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2012-05-04 11:03:57 +0200
committerLoïc Hoguin <[email protected]>2012-05-04 11:03:57 +0200
commit14b45fd8a91b8659a001559f5d84bf19611ee5d4 (patch)
tree169903fb49bd1ac944bb9a7364dd308c4806db25
parent0406a632dca8afbc1b22a0b4d556aa0004284b2b (diff)
downloadcowboy-14b45fd8a91b8659a001559f5d84bf19611ee5d4.tar.gz
cowboy-14b45fd8a91b8659a001559f5d84bf19611ee5d4.tar.bz2
cowboy-14b45fd8a91b8659a001559f5d84bf19611ee5d4.zip
Add a note about crypto websocket usage in the doc comments
-rw-r--r--src/cowboy_http_websocket.erl24
1 files changed, 3 insertions, 21 deletions
diff --git a/src/cowboy_http_websocket.erl b/src/cowboy_http_websocket.erl
index f3f1cae..f550041 100644
--- a/src/cowboy_http_websocket.erl
+++ b/src/cowboy_http_websocket.erl
@@ -14,27 +14,9 @@
%% @doc WebSocket protocol implementation.
%%
-%% Supports the protocol version 0 (hixie-76), version 7 (hybi-7)
-%% and version 8 (hybi-8, hybi-9 and hybi-10).
-%%
-%% Version 0 is supported by the following browsers:
-%% <ul>
-%% <li>Firefox 4-5 (disabled by default)</li>
-%% <li>Chrome 6-13</li>
-%% <li>Safari 5.0.1+</li>
-%% <li>Opera 11.00+ (disabled by default)</li>
-%% </ul>
-%%
-%% Version 7 is supported by the following browser:
-%% <ul>
-%% <li>Firefox 6</li>
-%% </ul>
-%%
-%% Version 8+ is supported by the following browsers:
-%% <ul>
-%% <li>Firefox 7+</li>
-%% <li>Chrome 14+</li>
-%% </ul>
+%% When using websockets, make sure that the crypto application is
+%% included in your release. If you are not using releases then there
+%% is no need for concern as crypto is already included.
-module(cowboy_http_websocket).
-export([upgrade/4]). %% API.