summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHiroshi Ichikawa <gimite@gmail.com>2011-04-03 19:54:32 +0900
committerHiroshi Ichikawa <gimite@gmail.com>2011-04-03 19:54:32 +0900
commit3c862a832ca819d6d6af3679440fcfe3c7b57877 (patch)
tree4ee94a2c19830e56c7e3920b22dac4ffaa9d1204
parent6b6dfb0ee0fe99dd65bc210f7b175959b5e36487 (diff)
downloadweb-socket-js-3c862a832ca819d6d6af3679440fcfe3c7b57877.tar.gz
Updating README.
-rw-r--r--README.md49
1 files changed, 24 insertions, 25 deletions
diff --git a/README.md b/README.md
index 95e63f6..57e4c0c 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,7 @@
Assuming you have Web server (e.g. Apache) running at **http://example.com/** .
-1. Download web_socket.rb from:
- [http://github.com/gimite/web-socket-ruby/tree/master](http://github.com/gimite/web-socket-ruby/tree/master)
+1. Download [web_socket.rb](http://github.com/gimite/web-socket-ruby/tree/master).
2. Run sample Web Socket server (echo server) in example.com with: (#1)
$ ruby web-socket-ruby/samples/echo_server.rb example.com 10081
3. If your server already provides socket policy file at port **843**, modify the file to allow access to port **10081**. Otherwise you can skip this step. See below for details.
@@ -19,29 +18,29 @@ Assuming you have Web server (e.g. Apache) running at **http://example.com/** .
1. Copy swfobject.js, web_socket.js, WebSocketMain.swf to your application directory.
2. Write JavaScript code:
- <!-- Imports JavaScript Libraries. -->
- <script type="text/javascript" src="swfobject.js"></script>
- <script type="text/javascript" src="web_socket.js"></script>
-
- <script type="text/javascript">
-
- // Let the library know where WebSocketMain.swf is:
- WebSocket.__swfLocation = "WebSocketMain.swf";
-
- // Write your code in the same way as for native WebSocket:
- var ws = new WebSocket("ws://example.com:10081/");
- ws.onopen = function() {
- ws.send("Hello"); // Sends a message.
- };
- ws.onmessage = function(e) {
- // Receives a message.
- alert(e.data);
- };
- ws.onclose = function() {
- alert("closed");
- };
-
- </script>
+ <!-- Imports JavaScript Libraries. -->
+ <script type="text/javascript" src="swfobject.js"></script>
+ <script type="text/javascript" src="web_socket.js"></script>
+
+ <script type="text/javascript">
+
+ // Let the library know where WebSocketMain.swf is:
+ WebSocket.__swfLocation = "WebSocketMain.swf";
+
+ // Write your code in the same way as for native WebSocket:
+ var ws = new WebSocket("ws://example.com:10081/");
+ ws.onopen = function() {
+ ws.send("Hello"); // Sends a message.
+ };
+ ws.onmessage = function(e) {
+ // Receives a message.
+ alert(e.data);
+ };
+ ws.onclose = function() {
+ alert("closed");
+ };
+
+ </script>
3. Put Flash socket policy file to your server unless you use web-socket-ruby or em-websocket as your WebSocket server. See "Flash socket policy file" section below for details.