Skip to content

Commit 4bc7000

Browse files
Fix dependencies section and add examples reference
Updated README to correct dependency section and added examples.
1 parent 4218f31 commit 4bc7000

File tree

1 file changed

+4
-11
lines changed

1 file changed

+4
-11
lines changed

README.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,16 @@ npm install @rescript-mui/material
1313

1414
```json
1515
{
16-
"bs-dependencies": ["@rescript-mui/material"]
16+
"dependencies": ["@rescript-mui/material"]
1717
}
1818
```
1919

2020
This library provides [ReScript](https://rescript-lang.org/) bindings for [MUI](https://mui.com/).
2121

22-
These bindings will only work with ReScript 11 (uncurried mode) and JSX version 4, as it enables us to utilize [untagged variants](https://rescript-lang.org/blog/improving-interop#untagged-variants), optional record fields, and record props spread. The latter is especially important, as we are finally able to inherit props from one component to another more easily.
22+
These bindings will only work with ReScript 11+ (uncurried mode) and JSX version 4, as it enables us to utilize [untagged variants](https://rescript-lang.org/blog/improving-interop#untagged-variants), optional record fields, and record props spread. The latter is especially important, as we are finally able to inherit props from one component to another more easily.
2323

24-
## What happened to the bindings for Material-UI 4?
25-
26-
They are still available, check out the old website: https://rescript-material-ui.cca.io/.
27-
28-
## Why no new website?
29-
30-
1. One of the goals of this rewrite is to make the usage of MUI in ReScript more accessible. In the best case you never need to leave your editor, since now we have doc comments for (almost) every property.
31-
2. It just takes too much time to maintain.
32-
3. In our opinion, it is much more useful (albeit not as pretty) to just have a look at the [examples folder](./examples/).
24+
## Examples
25+
Have a look at the [examples folder](./examples/).
3326

3427
## What's inside?
3528

0 commit comments

Comments
 (0)