Skip to content

Commit

Permalink
point to forked location
Browse files Browse the repository at this point in the history
  • Loading branch information
yetzt committed Jun 5, 2021
1 parent 4a5ea0a commit 1ca9e77
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# express-ws [![Dependency Status](https://snyk.io/test/github/henningm/express-ws/badge.svg)](https://snyk.io/test/github/henningm/express-ws)
# express-ws [![Dependency Status](https://snyk.io/test/github/yetzt/forked-express-ws/badge.svg)](https://snyk.io/test/github/yetzt/forked-express-ws)

Forked from [express-ws](https://github.com/HenningM/express-ws)

[WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) endpoints for [Express](http://expressjs.com/) applications. Lets you define WebSocket endpoints like any other type of route, and applies regular Express middleware. The WebSocket support is implemented with the help of the [ws](https://github.com/websockets/ws) library.

## Installation

`npm install --save express-ws`
`npm install --save @yetzt/express-ws`

## Usage

Expand All @@ -13,7 +15,7 @@ __Full documentation can be found in the API section below. This section only sh
Add this line to your Express application:

```javascript
var expressWs = require('express-ws')(app);
var expressWs = require('@yetzt/express-ws')(app);
```

__Important: Make sure to set up the `express-ws` module like above *before* loading or defining your routers!__ Otherwise, `express-ws` won't get a chance to set up support for Express routers, and you might run into an error along the lines of `router.ws is not a function`.
Expand Down Expand Up @@ -47,7 +49,7 @@ app.use("/ws-stuff", router);
```javascript
var express = require('express');
var app = express();
var expressWs = require('express-ws')(app);
var expressWs = require('@yetzt/express-ws')(app);

app.use(function (req, res, next) {
console.log('middleware');
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,17 @@
},
"repository": {
"type": "git",
"url": "https://github.com/HenningM/express-ws"
"url": "https://github.com/yetzt/forked-express-ws"
},
"keywords": [
"express",
"ws",
"websocket"
],
"bugs": {
"url": "https://github.com/HenningM/express-ws/issues"
"url": "https://github.com/yetzt/forked-express-ws/issues"
},
"homepage": "https://github.com/HenningM/express-ws",
"homepage": "https://github.com/yetzt/forked-express-ws",
"devDependencies": {
"eslint": "^7.28.0",
"eslint-config-airbnb": "^18.2.1",
Expand Down

0 comments on commit 1ca9e77

Please sign in to comment.