Fix README
Lint / lint (push) Successful in 55s

This commit is contained in:
Julien Valverdé
2026-07-26 00:19:10 +02:00
parent d32389fa81
commit 926eba0570
+59 -5
View File
@@ -1,7 +1,61 @@
# Effect FC Monorepo <p align="center">
<a href="https://thila.dev/effect-view">
<img src="packages/docs/static/img/logo.svg" width="104" height="104" alt="Effect View logo" />
</a>
</p>
[Effect-TS](https://effect.website/) integration for React 19.2+ that allows you to write function components using Effect generators. <h1 align="center">Effect View Monorepo</h1>
This monorepo contains: <p align="center">
- [The `effect-fc` library](packages/effect-fc) Write React components as typed Effect programs.
- [An example project](packages/example) </p>
This repository contains Effect View, its documentation, development examples,
and supporting tooling. Effect View brings Effect's typed services, resource
safety, concurrency, and data modeling to React while keeping ordinary React
components, hooks, and JSX.
## Packages
| Package | Description |
| --- | --- |
| [`effect-view`](packages/effect-fc-next) | The Effect View library for Effect v4 and React 19. |
| [`@effect-view/vite-plugin`](packages/vite-plugin) | Vite Fast Refresh support for Effect View components. |
| [`docs`](packages/docs) | The [Effect View documentation](https://thila.dev/effect-view), built with Docusaurus. |
| [`example-next`](packages/example-next) | Example application using Effect View and Effect v4. |
| [`effect-fc`](packages/effect-fc) | Legacy Effect v3 package. |
| [`example`](packages/example) | Example application for the legacy package. |
## Development
The monorepo uses [Bun](https://bun.sh/) workspaces and
[Turborepo](https://turbo.build/).
```bash
bun install
```
Run checks and builds from the repository root:
```bash
bun run lint:tsc
bun run lint:biome
bun run test
bun run build
```
Start the Effect View example or documentation site:
```bash
bun run --cwd packages/example-next dev
bun run --cwd packages/docs start
```
## Documentation
Read the documentation at
[thila.dev/effect-view](https://thila.dev/effect-view).
## License
[MIT](LICENSE)