Skip to content

Commit 25458ef

Browse files
tweak docs
1 parent 4fa9ec8 commit 25458ef

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ listener connection is automatically TLS/SSL protected without you having to jug
4545

4646
### Servers
4747

48-
The snippet below shows the "ws"/"hyco-ws" variant of creating a server. The API is usage is
48+
The snippet below shows the "ws"/"hyco-ws" variant of creating a server. The API usage is
4949
completely "normal" except for using the "hyco-ws" package and creating an instance of the
5050
*RelayedServer* instead of *Server*. The default underlying *Server* class remains fully available
5151
when using "hyco-ws" instead of "ws", meaning you can host a relayed and a local WebSocket
@@ -79,7 +79,7 @@ experience is analogous and explained in the package's README.
7979

8080
Up to 25 WebSocket listeners can listen concurrently on the same Hybrid Connection path on the
8181
Relay; if two or more listeners are connected, the service will automatically balance incoming
82-
connection requests across the connected listeners. which also provides an easy failover capability.
82+
connection requests across the connected listeners which also provides an easy failover capability.
8383
You don't have to do anything to enable this, just have multiple listeners share the same path.
8484

8585
Clients connect to the server through the Relay service on the same path the listener is listening
@@ -92,7 +92,7 @@ with a control message over the open control channel. The control message contai
9292
a "rendezvous endpoint" that is valid for a brief period. The server framework will decide whether
9393
to accept the incoming connection, potentially including calling some extensibility hooks, and
9494
then open an outbound WebSocket to the rendezvous endpoint. The client WebSocket and this "data"
95-
WenSocket are then bound into a single end-to-end connection by the Relay service, behaving like
95+
WebSocket are then bound into a single end-to-end connection by the Relay service, behaving like
9696
a single WebSocket.
9797

9898
### Clients
@@ -108,8 +108,8 @@ preferred; mostly since URLs end up in many logs.
108108
var address = WebSocket.createRelaySendUri(ns, path),
109109

110110
var client = new WebSocket(address, null, opt);
111-
client.on('open', function(wss) {
112-
wss.send("Hi!");
111+
client.on('open', function() {
112+
client.send("Hi!");
113113
});
114114

115115
```
@@ -142,7 +142,7 @@ replaced with the correct values for namespace, path, and token using a template
142142
The README documents for the two includes packages discuss the particular additions made
143143
to accomodate support for Hybrid Connections. What's common for both libraries is that
144144
you can use the 'hyco-ws' and the 'hyco-websocket' packages instead of the 'ws' and 'websocket'
145-
without losing any existing functionality. Both packages containe to expose the full and unaltered
145+
without losing any existing functionality. Both packages contain and expose the full and unaltered
146146
functionality of their respective base packages.
147147

148148
* [README for hyco-ws](./hyco-ws/README.md)

0 commit comments

Comments
 (0)