Document usage with opam + npm

reasonml / reason-react

Reason bindings for ReactJS

https://reasonml.github.io/reason-react/

MIT License

3.25k stars 347 forks source link

Document usage with opam + npm #717

Open jchavarri opened 1 year ago

jchavarri commented 1 year ago

As these bindings are now targeting Melange, the main supported workflow will be consuming it through opam. This means users of reason-react will need to add react as a dependency on their package.json manually. Similarly to how OCaml native bindings do with underlying dependencies.

This should be documented in the README and docs, including the version of ReactJS that is supported (I think 16 at the moment).

jchavarri commented 12 months ago

We could mention opam-check-npm-deps, see related https://github.com/reasonml/reason-react/pull/760