Skip to content

Update README to remove websocket support note#123

Merged
ValwareIRC merged 1 commit into
mainfrom
ValwareIRC-patch-1
Jan 12, 2026
Merged

Update README to remove websocket support note#123
ValwareIRC merged 1 commit into
mainfrom
ValwareIRC-patch-1

Conversation

@ValwareIRC
Copy link
Copy Markdown
Contributor

@ValwareIRC ValwareIRC commented Jan 12, 2026

Removed note about websocket support from README.

Summary by CodeRabbit

  • Documentation
    • Updated README to clarify platform support information

✏️ Tip: You can customize this high-level summary in your review settings.

Removed note about websocket support from README.
Copilot AI review requested due to automatic review settings January 12, 2026 21:11
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jan 12, 2026

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The 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

Cohort / File(s) Summary
Documentation update
README.md
Removed informational note regarding websockets-only support

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A note takes flight like wind through trees,
The websockets truth was set to ease,
No longer marked with asterisks bold,
The README breathes, cleaner than before told. 🐰✨


📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 34633d7 and 4d0eff3.

📒 Files selected for processing (1)
  • README.md

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@ValwareIRC ValwareIRC merged commit 52d3888 into main Jan 12, 2026
7 of 8 checks passed
@github-actions
Copy link
Copy Markdown

Pages Preview
Preview URL: https://valwareirc-patch-1.obsidianirc.pages.dev

Automated deployment preview for the PR in the Cloudflare Pages.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md
### React + TypeScript + TailwindCSS

*Important:* Only websockets are supported

Copy link

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
zocram4cc pushed a commit to zocram4cc/ObsidianIRC that referenced this pull request Feb 17, 2026
Removed note about websocket support from README.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants