Clarify package install commands and release-channel guidance in README - #202
Merged
Conversation
Agent-Logs-Url: https://github.com/yjs/y-websocket/sessions/d72892db-b777-4829-aa3b-07a3bc338fb6 Co-authored-by: dmonad <5553757+dmonad@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update readme npm install command for correct package
Clarify package install commands and release-channel guidance in README
Apr 18, 2026
dmonad
approved these changes
Apr 18, 2026
dmonad
marked this pull request as ready for review
April 18, 2026 13:39
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README mixed stable and development package context, which made install guidance ambiguous. This update clarifies which package users should install and distinguishes stable usage from
mainbranch development docs.Release-channel clarification
y-websocketrelease withyjsv13.maintracks unstable@y/websocketdevelopment for Yjs v14 (@y/y), and that most users should continue using stable v13.Install command clarity
y-websocket@y/websocket