Add a note about crypto websocket usage in the doc comments

tsloughter · May 4, 2012 · 14b45fd · 14b45fd
1 parent 0406a63
commit 14b45fd
Showing 1 changed file with 3 additions and 21 deletions.
diff --git 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)
+%% When using websockets, make sure that the crypto application is
-%% and version 8 (hybi-8, hybi-9 and hybi-10).
+%% included in your release. If you are not using releases then there
-%%
+%% is no need for concern as crypto is already included.
-%% 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>
 -module(cowboy_http_websocket).
 
 -export([upgrade/4]). %% API.