Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@

React components for rendering messages from [`@worldware/msg`](https://www.npmjs.com/package/@worldware/msg).

## Installation

`@worldware/msg` is a **peer dependency** of `@worldware/msg-react` (and is marked external in the build). Install both packages in your app:

```bash
npm install @worldware/msg @worldware/msg-react
```

That keeps a single shared `@worldware/msg` instance and types in the dependency tree and avoids duplicate copies.

## Components

### `MsgResourceProvider`
Expand Down
3 changes: 2 additions & 1 deletion project/info.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ process in `project/process.md`. Keep it accurate — the process depends on it.
- **UI:** React 19 (peer/dev dependency for components and tests).
- **Test runner:** [Vitest](https://vitest.dev) with `@vitest/coverage-v8`, jsdom, and Testing Library (`@testing-library/react`). Config in `vitest.config.js`; setup in `src/test/setup.ts`.
- **Build:** [tsup](https://tsup.egoist.dev) for dual ESM/CJS bundles, plus `tsc -p tsconfig.build.json` for declaration files (`npm run build` → `dist/`). Config in `tsup.config.ts`.
- **Key dependencies:** `@worldware/msg`, `react`, `react-dom`, `messageformat`.
- **Key dependencies:** `@worldware/msg` (peer + dev; consumers must install it
alongside this package), `react`, `react-dom`, `messageformat`.

## Repository structure

Expand Down
Loading