Skip to content

Commit 75e008a

Browse files
committed
Update README
1 parent 584d990 commit 75e008a

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,32 @@
11
## rescript-react
22

33
> The Official ReScript Bindings for ReactJS
4-
>
5-
> **Note:** These bindings are in the publishing phase. Proper npm release will follow soon!
4+
5+
- [Documentation](https://rescript-lang.org/docs/react/latest/introduction)
66

77
### Transition Plan (reason-react -> rescript-react)
88

99
- Existing users want to upgrade from `[email protected]` to `[email protected]` (should be a smooth transition, check out the [Changes.md](./Changes.md) for minor breaking changes)
1010
- We will soon publish our `v1.0` changes, with a new `react-jsx` version and some other cool features! Check out our [RFC post](https://forum.rescript-lang.org/t/rfc-rescript-react/901) for more infos.
1111

12+
### Installation
13+
14+
```
15+
npm install @rescript/react --save
16+
```
17+
18+
In your `bsconfig.json`:
19+
20+
```
21+
{
22+
"reason": { "react-jsx": 3 },
23+
"bs-dependencies": ["@rescript/react"]
24+
}
25+
```
26+
1227
**Quick Links:**
1328

1429
- [Introduction](https://rescript-lang.org/docs/react/latest/introduction)
15-
- [Installation](https://rescript-lang.org/docs/react/latest/installation) (Please note that our npm package is not released yet. Coming soon!)
1630

1731
### Requirements
1832

0 commit comments

Comments
 (0)