-
Notifications
You must be signed in to change notification settings - Fork 39
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.
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
Conversation
WalkthroughThis pull request updates documentation and one dev dependency for the web-transport-ws project. The README gains a Usage section documenting how to run the example server and clients (including bun and deno), how to bundle TypeScript into a single JavaScript file, and how to run it with Node. The devDependency "ws" (^8.16.0) was removed from package.json. No functional or API changes were made. Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
web-transport-ws/package-lock.jsonis excluded by!**/package-lock.jsonweb-transport-ws/pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (2)
web-transport-ws/README.md(1 hunks)web-transport-ws/package.json(0 hunks)
💤 Files with no reviewable changes (1)
- web-transport-ws/package.json
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
web-transport-ws/README.md
49-49: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
53-53: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
58-58: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
62-62: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
https://nodejs.org/en/learn/getting-started/websocket
https://docs.deno.com/api/web/~/WebSocket
https://bun.com/docs/runtime/http/websockets
Summary by CodeRabbit
Documentation
Chores