From 14b45fd8a91b8659a001559f5d84bf19611ee5d4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@dev-extend.eu>
Date: Fri, 4 May 2012 11:03:57 +0200
Subject: Add a note about crypto websocket usage in the doc comments

---
 src/cowboy_http_websocket.erl | 24 +++---------------------
 1 file changed, 3 insertions(+), 21 deletions(-)

(limited to 'src/cowboy_http_websocket.erl')

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.
-- 
cgit v1.2.3