Skip to content

Commit 01e1d27

Browse files
committed
Update README.md
1 parent db3fcd1 commit 01e1d27

File tree

1 file changed

+39
-4
lines changed

1 file changed

+39
-4
lines changed

README.md

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,47 @@
11
# `@reason-react-native/navigation`
22

3-
[Reason](https://reasonml.github.io) bindings to
4-
[react-navigation](https://github.com/react-navigation/react-navigation).
3+
[ReasonML](https://reasonml.github.io) /
4+
[BuckleScript](https://bucklescript.github.io) bindings for
5+
[`react-navigation`](https://github.com/react-navigation/react-navigation).
6+
7+
Exposed as `ReactNavigation` module.
8+
9+
`@reason-react-native/navigation` X.y._ means it's compatible with
10+
`react-navigation` X.y._
511

612
## Status
713

8-
Work in progress. These bindings are used successfully in several apps, but are
9-
not complete yet and still subject to change.
14+
⚠️ Work in progress. These bindings are used successfully in several apps, but
15+
are not complete yet and still subject to change.
16+
17+
## Installation
18+
19+
When
20+
[`react-navigation`](`https://github.com/react-navigation/react-navigation`) is
21+
properly installed & configured by following their installation instructions,
22+
you can install the bindings:
23+
24+
```console
25+
npm install @reason-react-native/navigation
26+
# or
27+
yarn add @reason-react-native/navigation
28+
```
29+
30+
`@reason-react-native/navigation` should be added to `bs-dependencies` in your
31+
`bsconfig.json`. Something like
32+
33+
```diff
34+
{
35+
//...
36+
"bs-dependencies": [
37+
"reason-react",
38+
"reason-react-native",
39+
// ...
40+
+ "@reason-react-native/navigation"
41+
],
42+
//...
43+
}
44+
```
1045

1146
## Example
1247

0 commit comments

Comments
 (0)