diff --git a/README.md b/README.md index 7ef96b6..dab847a 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,6 @@ This library is in early development. While it is (almost) feature complete and Documentation is currently being written. In the meantime, you can take a look at the `packages/example` directory. ## Dependencies -(need to be manually installed) +(needs to be manually installed) - `effect` - `react` 19+ diff --git a/packages/reffuse/README.md b/packages/reffuse/README.md new file mode 100644 index 0000000..dab847a --- /dev/null +++ b/packages/reffuse/README.md @@ -0,0 +1,12 @@ +# Reffuse + +[Effect-TS](https://effect.website/) integration for React 19+ with the aim of integrating the Effect context system within React's component hierarchy, while avoiding touching React's internals. + +This library is in early development. While it is (almost) feature complete and mostly usable, expect bugs and quirks. Things are still being ironed out, so ideas and criticisms are more than welcome. + +Documentation is currently being written. In the meantime, you can take a look at the `packages/example` directory. + +## Dependencies +(needs to be manually installed) +- `effect` +- `react` 19+ diff --git a/packages/reffuse/package.json b/packages/reffuse/package.json index 4458593..f85e0fb 100644 --- a/packages/reffuse/package.json +++ b/packages/reffuse/package.json @@ -3,8 +3,11 @@ "version": "0.1.0", "type": "module", "files": [ + "./README.md", "./dist" ], + "license": "MIT", + "repository": "github:Thiladev/reffuse", "types": "./dist/index.d.ts", "exports": { ".": {