Update documentation

sockjs · Sep 26, 2018 · a15705b · a15705b
1 parent b74358b
commit a15705b
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,13 +1,24 @@
-Unreleased
-======
+# Unreleased
+
+## **BREAKING CHANGES**
+  * `installHandlers(server, options)` renamed to `attach(server)` and only takes a single argument.
+  This means you cannot use the same SockJS server installed at multiple prefixes.
+  In practice this was confusing and not common.
+  * `websocket` option is deprecated, but still respected. Please use       the new `transports` option.
+  * Node.js `>= 6.5.0` is required.
 
+## Other Fixes/Changes
   * Convert from coffeescript to ES6.
   * Update minimum Node.js version to 6.X.
   * Update SockJSConnection implementation to be compatible with latest Node.js streams.
   * SockJSConnection properties `readable` and `writable` have been removed. These are used internally by Node.js streams.
   * Remove `console.log` logging by default.
   * Remove usage of exceptions for flow control.
   * Add `debug` logs for easier troubleshooting.
+  * Added `transports` option to allow selection of specific transports.
+  * Added `detach(server)` function to remove SockJS from a HTTP server instance.
+  * Update dependencies.
+  * Examples have been updated to use latest versions of libraries.
 
 
 0.3.19

diff --git a/README.md b/README.md
@@ -191,7 +191,7 @@ and emits following event:
 All http requests that don't go under the path selected by `prefix`
 will remain unanswered and will be passed to previously registered
 handlers. You must install your custom http handlers before calling
-`attach`.
+`attach`. You can remove the SockJS handler later with `detach`.
 
 ### Connection instance