diff --git a/README.md b/README.md index b2d9624..27e95c2 100644 --- a/README.md +++ b/README.md @@ -52,5 +52,6 @@ import 'cypress-hmr-restarter/gatsby'; When using the [Cypress Test Runner](https://docs.cypress.io/guides/core-concepts/test-runner.html) (`cypress open`), after the window has loaded, it will try to connect and listen for events. When an event signifying a change has happened, it will first try clicking the stop button, and then, after a short delay, it will click the restart button. - The default import connects to the [`webpack-dev-server`](https://www.npmjs.com/package/webpack-dev-server) websocket at either `` or `ws:///sockjs-node` (`wss:` if `https:`), and listens for messages with the type `invalid`. +**IMPORTANT:** You need to ensure that [`transportMode`](https://webpack.js.org/configuration/dev-server/#devservertransportmode) option of `webpack-dev-server` is set to `ws` for the feature to work. - The gatsby import connects to the [`webpack-hot-middleware`](https://www.npmjs.com/package/webpack-hot-middleware) event source at either `` or `/__webpack_hmr`, and listens for messages with the action `built`.