Skip to content

docs: link use references in React README #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aose-yuu merged 1 commit into from
May 24, 2026
Merged

docs: link use references in React README #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 11 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ npm install @sigrea/react @sigrea/core react react-dom

Requires React 18+ and Node.js 24 or later.

Install `@sigrea/use` too if your shared molecules use helpers from that
package, such as `createEvents`.
Install [`@sigrea/use`][sigrea-use] too if your shared molecules use helpers
from that package, such as `createEvents`.

## Quick Start

Expand Down Expand Up @@ -157,7 +157,8 @@ export function ProfileForm() {

For controlled UI, keep the value in a controller molecule. A child molecule
calls `send("update:open", next)` when it wants the value to change.
`@sigrea/use` provides `createEvents()` for this pattern.
[`@sigrea/use`][sigrea-use] provides [`createEvents()`][create-events] for this
pattern.

```tsx
import {
Expand Down Expand Up @@ -326,7 +327,7 @@ up after each test.
## Handling Scope Cleanup Errors

For global error handling configuration, see
[@sigrea/core - Handling Scope Cleanup Errors](https://github.com/sigrea/core#handling-scope-cleanup-errors).
[@sigrea/core - Handling Scope Cleanup Errors][core-cleanup-errors].

Configure the handler in your application entry point before rendering:

Expand Down Expand Up @@ -362,8 +363,13 @@ This repo targets Node.js 24 or later.

If you use mise, run `mise trust -y` once before using mise tasks.

See [CONTRIBUTING.md](./CONTRIBUTING.md) for workflow details.
See [CONTRIBUTING.md](https://github.com/sigrea/react/blob/main/CONTRIBUTING.md)
for workflow details.

## License

MIT. See [LICENSE](./LICENSE).

[core-cleanup-errors]: https://github.com/sigrea/core#handling-scope-cleanup-errors
[create-events]: https://github.com/sigrea/use/tree/main/packages/use/createEvents
[sigrea-use]: https://www.npmjs.com/package/@sigrea/use