Skip to content

Commit eaba3cf

Browse files
committed
Minor README tweaks
1 parent bdf470d commit eaba3cf

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.markdown

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Java WebSockets
22
===============
33

44
This repository contains a barebones WebSocket server and client implementation
5-
written 100% in in Java. The implementation supports both the older draft 75,
5+
written in 100% Java. The implementation supports both the older draft 75,
66
and current draft 76. The underlying classes use the Java
77
`ServerSocketChannel` and `SocketChannel` classes, which allows for a
88
non-blocking event-driven model (similar to the
@@ -15,15 +15,16 @@ There's a simple chat server and client example located in the `example`
1515
folder. First, compile the example classes and JAR file:
1616
ant
1717

18-
Then, start the chat server (a WebSocketServer subclass):
18+
Then, start the chat server (a `WebSocketServer` subclass):
1919
java -cp example:dist/WebSocket.jar ChatServer
2020

2121
Now that the server is started, we need to connect some clients. Run the
22-
Java chat client (a WebSocketClient subclass):
22+
Java chat client (a `WebSocketClient` subclass):
2323
java -cp example:dist/WebSocket.jar ChatClient
2424

25-
The chat client is a simple Swing GUI that allows you to send messages to
26-
all other connected clients, and receive messages from others in a text box.
25+
The chat client is a simple Swing GUI application that allows you to send
26+
messages to all other connected clients, and receive messages from others in a
27+
text box.
2728

2829
There's also a simple HTML file chat client `chat.html`, which can be opened
2930
by any browser. If the browser natively supports the WebSocket API, then it's
@@ -33,7 +34,7 @@ implementation will be used, otherwise it will fall back to a
3334
Writing your own WebSocket Server
3435
---------------------------------
3536

36-
The `net.tootallnate.websocket.WebSocketServer` class implements the
37+
The `net.tootallnate.websocket.WebSocketServer` abstract class implements the
3738
server-side of the
3839
[WebSocket Protocol](<http://www.whatwg.org/specs/web-socket-protocol/>).
3940
A WebSocket server by itself doesn't do anything except establish socket
@@ -42,10 +43,11 @@ connections though HTTP. After that it's up to **your** subclass to add purpose.
4243
Writing your own WebSocket Client
4344
---------------------------------
4445

45-
The `net.tootallnate.websocket.WebSocketClient` class can connect to valid
46-
WebSocket servers. The constructor expects a valid `ws://` URI to connect to.
47-
Important events `onOpen`, `onClose`, and `onMessage` get fired throughout the
48-
life of the WebSocketClient, and must be implemented in your subclass.
46+
The `net.tootallnate.websocket.WebSocketClient` abstract class can connect to
47+
valid WebSocket servers. The constructor expects a valid `ws://` URI to
48+
connect to. Important events `onOpen`, `onClose`, and `onMessage` get fired
49+
throughout the life of the WebSocketClient, and must be implemented in **your**
50+
subclass.
4951

5052
License
5153
-------

0 commit comments

Comments
 (0)