README

README.md

@@ -0,0 +1,15 @@
+Erlang-based server side component for SockJS. See:
+
+https://github.com/majek/sockjs-client
+
+for more information on SockJS.
+
+Currently this is rather limited:
+
+* Requires Misultin
+* Supports WebSockets via Misultin (so no hybi-10!)
+* Various header-based things haven't been ported from the node server
+* Hasn't been tested much
+* Hasn't been performance-tested at all
+
+Hopefully in future some of these restrictions will get improved.