[Pkg-javascript-commits] [sockjs-client] 37/434: Brief readme

[Tonnerre Lombard]

This is an automated email from the git hooks/post-receive script.

tonnerre-guest pushed a commit to branch master
in repository sockjs-client.

commit 3f903cf33328468b58ecad1ce09298bd78058187
Author: Marek Majkowski <majek04 at gmail.com>
Date:   Tue Aug 2 11:23:21 2011 +0100

    Brief readme
---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0fe72aa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+
+SockJS
+======
+
+HTML5 WebSockets-like API for the older browsers.
+
+ * No Flash inside (no need to open port 843 - which often doesn't
+   work through proxies, no need to host `crossdomain.xml`)
+ * All the transports support cross domain connections. It's possible
+   and recommended to host SockJS on different domain than your main
+   web site.
+ * Polling transports are be used as a fallback for old browsers and
+   hosts behind restrictive proxies.
+
+
+Supported transports
+--------------------
+
+Protocol                      | Browser
+----------------------------- | -------------
+WebSocket hixie-76[^1]        | Chrome 6-12
+WebSocket-hybi-10[^2]         | Chrome 14+, Firefox 6+
+Cross domain XHR - multipart  | IE 8, Firefox 3.5+, Safari 4+
+Cross domain XHR - polling    | IE 8, Firefox 3.5+, Safari 4+, Chrome 3+ (through misbehaving proxy)
+Iframe[^3]  + XHR polling     | Opera 9+
+JsonP polling                 | (fallback)
+
+
+[^1]: http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76
+[^2]: http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-10
+[^3]: Using [`postMessage` feature ](https://developer.mozilla.org/en/DOM/window.postMessage)

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/sockjs-client.git