Skip to content

Clarify package install commands and release-channel guidance in README - #202

Merged
dmonad merged 2 commits into
masterfrom
copilot/update-readme-npm-install-command
Apr 18, 2026
Merged

Clarify package install commands and release-channel guidance in README#202
dmonad merged 2 commits into
masterfrom
copilot/update-readme-npm-install-command

Conversation

Copilot AI commented Apr 18, 2026

Copy link
Copy Markdown
Contributor

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 main branch development docs.

  • Release-channel clarification

    • Added a top-level note that this README primarily describes the stable y-websocket release with yjs v13.
    • Documented that main tracks unstable @y/websocket development for Yjs v14 (@y/y), and that most users should continue using stable v13.
  • Install command clarity

    • Updated the install section to show both package names with explicit intent:
      • stable/recommended: y-websocket
      • unstable/main-branch line: @y/websocket
# stable release (recommended)
npm i y-websocket

# main branch / unstable release
npm i @y/websocket

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
Copilot AI requested a review from dmonad April 18, 2026 13:37
@dmonad
dmonad marked this pull request as ready for review April 18, 2026 13:39
@dmonad
dmonad merged commit f9559e6 into master Apr 18, 2026
3 of 9 checks passed
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.

Update readme npm install command to point correct package

2 participants