Document that @worldware/msg is a peer dependency of @worldware/msg-react, not a bundled/transitive dependency consumers can rely on alone.
User story
As a msg-react user, I want the README (and any install docs) to say I must install both packages, so I do not hit missing-module errors or assume msg comes for free with msg-react.
What to document
Suggested places
README.md — add an Installation section before Usage (Usage already imports from @worldware/msg but never states the peer install).- Optionally mirror a one-liner in
project/info.md if that file is meant for consumers/agents.
Out of scope
- Changing peer/dev dependency ranges.
- Making
@worldware/msg a regular dependency.
Document that
@worldware/msgis a peer dependency of@worldware/msg-react, not a bundled/transitive dependency consumers can rely on alone.User story
As a msg-react user, I want the README (and any install docs) to say I must install both packages, so I do not hit missing-module errors or assume
msgcomes for free withmsg-react.What to document
@worldware/msgis declared as apeerDependency(and used as a tsupexternal); apps must install it themselves.Recommended install:
Brief rationale: one shared
msginstance/types in the app tree; avoiding duplicates.Suggested places
README.md— add an Installation section before Usage (Usage already imports from@worldware/msgbut never states the peer install).project/info.mdif that file is meant for consumers/agents.Out of scope
@worldware/msga regulardependency.