README.md in faye-websocket-0.10.4 vs README.md in faye-websocket-0.10.5
- old
+ new
@@ -8,17 +8,18 @@
This is a general-purpose WebSocket implementation extracted from the
[Faye](http://faye.jcoglan.com) project. It provides classes for easily building
WebSocket servers and clients in Ruby. It does not provide a server itself, but
rather makes it easy to handle WebSocket connections within an existing
[Rack](http://rack.github.io/) application. It does not provide any abstraction
-other than the standard [WebSocket API](http://dev.w3.org/html5/websockets/).
+other than the standard [WebSocket
+API](https://html.spec.whatwg.org/multipage/comms.html#network).
It also provides an abstraction for handling
-[EventSource](http://dev.w3.org/html5/eventsource/) connections, which are
-one-way connections that allow the server to push data to the client. They are
-based on streaming HTTP responses and can be easier to access via proxies than
-WebSockets.
+[EventSource](https://html.spec.whatwg.org/multipage/comms.html#server-sent-events)
+connections, which are one-way connections that allow the server to push data to
+the client. They are based on streaming HTTP responses and can be easier to
+access via proxies than WebSockets.
The following web servers are supported. Other servers that implement the
`rack.hijack` API should also work.
* [Goliath](http://postrank-labs.github.com/goliath/)
@@ -196,10 +197,12 @@
sent during the handshake process
* `:max_length` - the maximum allowed size of incoming message frames, in bytes.
The default value is `2^26 - 1`, or 1 byte short of 64 MiB.
* `:ping` - an integer that sets how often the WebSocket should send ping
frames, measured in seconds
-
+* `:tls` - a hash containing key-value pairs for specifying TLS parameters.
+ These are passed along to EventMachine and you can find
+ [more details here](http://rubydoc.info/gems/eventmachine/EventMachine%2FConnection%3Astart_tls)
## WebSocket API
Both the server- and client-side `WebSocket` objects support the following API: