Skip to content

Commit c44bee3

Browse files
authored
Update README.MD
1 parent c0d7f1b commit c44bee3

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.MD

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,11 @@ This library is tested in __browsers__ (at least Internet Explorer 10) and in __
1010

1111
Both the server and client support two __transports, HTTP and WebSocket__, and allow more through plugin extensibility.
1212

13-
For WebSocket client support it expects W3C compatible WebSocket class instances (browser `WebSocket` and Node.js [websockets/ws](https://github.com/websockets/ws) `WebSocket`). On the Node.js side it is tested to work with [websockets/ws](https://github.com/websockets/ws). `WebSocketServer` implementations are supported only if 100% API compatible with `websockets/ws`, or made compatible through an adapter.
13+
__Any WebSocket implementation may be used__, handling of the HTTP server and WebSocket is external to these JSONRPC classes.
14+
15+
For WebSocket client support, it expects W3C compatible WebSocket class instances (out of the box browser `WebSocket` and Node.js [websockets/ws](https://github.com/websockets/ws) `WebSocket`).
16+
17+
On the Node.js side it is tested to work with [websockets/ws](https://github.com/websockets/ws). Other `WebSocketServer` implementations are supported if API compatible with `websockets/ws` (constructor and events), or made compatible through an adapter.
1418

1519
Plugins are allowed to replace the JSON-RPC protocol altogether, extend the protocol or wrap it.
1620

0 commit comments

Comments
 (0)