Update README to remove websocket support note#123
Conversation
Removed note about websocket support from README.
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughThe README.md documentation was updated to remove an informational note about websockets support. This is a documentation-only change with no impact on code functionality or behavior. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
📜 Recent review detailsConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (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 |
|
Automated deployment preview for the PR in the Cloudflare Pages. |
There was a problem hiding this comment.
Pull request overview
This PR removes an outdated note from the README stating that only websockets are supported. Based on the codebase review, the application actually supports both WebSocket protocols (ws://, wss://) and TCP protocols (irc://, ircs://), making this removal appropriate.
Changes:
- Removed the "Important: Only websockets are supported" note from the README header section
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### React + TypeScript + TailwindCSS | ||
|
|
||
| *Important:* Only websockets are supported | ||
|
|
There was a problem hiding this comment.
The removal of the "Only websockets are supported" note appears incomplete. The Live Demo section on line 86 still states "connect to an IRC server which uses websockets!" which may also need updating for consistency, since the codebase actually supports both WebSocket protocols (ws://, wss://) and TCP protocols (irc://, ircs://) as shown in src/lib/socket.ts.
Removed note about websocket support from README.
Removed note about websocket support from README.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.