Updated the README file for the ant build script and removed warning for Draft 76.

TooTallNate · TooTallNate · commit e9e99919ef65 · 2010-07-24T13:59:37.000-07:00
diff --git a/README.markdown b/README.markdown
@@ -1,49 +1,51 @@
 Java WebSockets
 ===============
-### CAUTION/TODO: This WebSocket implementation adheres to an older draft of the WebSocket specification (draft 75). The [current draft](http://www.whatwg.org/specs/web-socket-protocol/) (draft 76) is a TODO item/fork-worthy! ###
 
-This repository contains a simple WebSocket server and client implementation
-in Java. The underlying classes use the Java classes `ServerSocketChannel` and
-`SocketChannel`, to allow for a non-blocking event-driven model (similar to the
+This repository contains a barebones WebSocket server and client implementation
+written 100% in in Java. The implementation supports both the older draft 75,
+and current draft 76. The underlying classes use the Java
+`ServerSocketChannel` and `SocketChannel` classes, which allows for a
+non-blocking event-driven model (similar to the
 [WebSocket API](<http://dev.w3.org/html5/websockets/>) for web browsers).
 
 Running the Example
 -------------------
 
 There's a simple chat server and client example located in the `example`
-folder.
+folder. First, compile the example classes and JAR file:
+    ant
 
-First, start the chat server (a WebSocketServer subclass):
-    cd example/
-    java ChatServer
+Then, start the chat server (a WebSocketServer subclass):
+    java -cp example:dist/WebSocket.jar ChatServer
 
 Now that the server is started, we need to connect some clients. Run the
 Java chat client (a WebSocketClient subclass):
-    java ChatClient
+    java -cp example:dist/WebSocket.jar ChatClient
 
 The chat client is a simple Swing GUI that allows you to send messages to
-all other connected clients, and recieve messages from others in a text box.
+all other connected clients, and receive messages from others in a text box.
 
 There's also a simple HTML file chat client `chat.html`, which can be opened
-by any browser. If the browser natively supports the WebSocket API, then it will
-be used, otherwise it will fall back to a
+by any browser. If the browser natively supports the WebSocket API, then it's
+implementation will be used, otherwise it will fall back to a
 [Flash-based WebSocket Implementation](<http://github.com/gimite/web-socket-js>).
 
 Writing your own WebSocket Server
 ---------------------------------
 
+The `net.tootallnate.websocket.WebSocketServer` class implements the
+server-side of the
+[WebSocket Protocol](<http://www.whatwg.org/specs/web-socket-protocol/>).
 A WebSocket server by itself doesn't do anything except establish socket
-connections though HTTP. After that it's up to a subclass to add purpose.
-The `WebSocketServer` class implements the server-side of the
-[WebSocket Protocol](<http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol>).
+connections though HTTP. After that it's up to **your** subclass to add purpose.
 
 Writing your own WebSocket Client
 ---------------------------------
 
-The `WebSocketClient` class can connect to valid WebSocket servers.
-The constructor expects a valid `ws://` URI to connect to. Important
-events `onOpen`, `onClose`, and `onMessage` get fired throughout the life
-of the WebSocketClient, and must be implemented in your subclass.
+The `net.tootallnate.websocket.WebSocketClient` class can connect to valid
+WebSocket servers. The constructor expects a valid `ws://` URI to connect to.
+Important events `onOpen`, `onClose`, and `onMessage` get fired throughout the
+life of the WebSocketClient, and must be implemented in your subclass.
 
 License
 -------
