Skip to content

docs(readme): document peer install of @worldware/msg - #8

Merged
jsahleen merged 1 commit into
mainfrom
msg-react-7
Aug 11, 2026
Merged

docs(readme): document peer install of @worldware/msg#8
jsahleen merged 1 commit into
mainfrom
msg-react-7

Conversation

@jsahleen

Copy link
Copy Markdown
Collaborator

Summary

  • Add an Installation section to the README stating that @worldware/msg is a peer dependency and must be installed with @worldware/msg-react.
  • Note the peer relationship in project/info.md for agents.

Closes #7

Test plan

  • npm test / npx tsc --noEmit / npm run build green
  • README Installation section is clear before Usage
  • Note: suite coverage remains ~86% (pre-existing; docs-only change)

Made with Cursor

Tell consumers to install @worldware/msg alongside msg-react and
note the peer relationship in project/info.md. Refs #7.

Co-authored-by: Cursor <cursoragent@cursor.com>
@jsahleen
jsahleen marked this pull request as ready for review August 11, 2026 03:06
@jsahleen
jsahleen merged commit d0d140c into main Aug 11, 2026
1 check passed
@jsahleen
jsahleen deleted the msg-react-7 branch August 11, 2026 03:08
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 1.1.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document that consumers must install @worldware/msg alongside msg-react

1 participant