Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document usage with opam + npm #717

Open
jchavarri opened this issue May 4, 2023 · 1 comment
Open

Document usage with opam + npm #717

jchavarri opened this issue May 4, 2023 · 1 comment
Labels
docs issues that are about providing better documentation

Comments

@jchavarri
Copy link
Collaborator

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).
@davesnx davesnx added the docs issues that are about providing better documentation label Jul 10, 2023
@jchavarri
Copy link
Collaborator Author

We could mention opam-check-npm-deps, see related #760

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs issues that are about providing better documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jchavarri @davesnx