Skip to content

Update README.md with usage details; WebSocket is built in to node, deno and bun #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Nov 18, 2025
Merged

Update README.md with usage details; WebSocket is built in to node, deno and bun #128

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3ccec62
Update README.md
guest271314 Nov 18, 2025
e6c17a1
node, deno, and bun are shipped with builtin WebSocket
guest271314 Nov 18, 2025
27cf5e3
node, deno, and bun are shipped with builtin WebSocket
guest271314 Nov 18, 2025
ec6d63c
node, deno, and bun are shipped with builtin WebSocket
guest271314 Nov 18, 2025
fb09e61
node, deno, and bun are shipped with builtin WebSocket
guest271314 Nov 18, 2025
dbe8d45
Update README.md
guest271314 Nov 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions web-transport-ws/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,29 @@ npm install
npm run build
```

### Usage
```bash
cargo run --example server
```

```
bun examples/client.ts
```

```
deno -A --sloppy-imports examples/client.ts
```

#### Bundle TypeScript source to single JavaScript file
```
bun build --target=node --outfile=examples/client.js examples/client.ts
```

```
node examples/client.js
```


## License

MIT OR Apache-2.0
25 changes: 1 addition & 24 deletions web-transport-ws/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion web-transport-ws/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
},
"devDependencies": {
"typescript": "^5.9.2",
"ws": "^8.16.0",
"rimraf": "^6.0.1",
"@types/node": "^24.3.0",
"tsx": "^4.20.5"
Expand Down
17 changes: 0 additions & 17 deletions web-transport-ws/pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.