Skip to content

Commit b1b9742

Browse files
committed
Adjust things for "ReScript" branding
1 parent cdb6658 commit b1b9742

File tree

3 files changed

+16
-30
lines changed

3 files changed

+16
-30
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ node_modules
99
# npm unused lock file (we use yarn.lock)
1010
package-lock.json
1111

12-
# Ocaml / Reason / BuckleScript artifacts
12+
# ReScript / Reason / Ocaml artifacts
1313
#*.bs.js # we do want this files to ensure zero-cost
1414
.bsb.lock
1515
**/lib/bs

README.md

Lines changed: 14 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,52 +4,37 @@
44
[![Version](https://img.shields.io/npm/v/@reason-react-native/netinfo.svg)](https://www.npmjs.com/@reason-react-native/netinfo)
55
[![Chat](https://img.shields.io/discord/235176658175262720.svg?logo=discord&colorb=blue)](https://reason-react-native.github.io/discord/)
66

7-
Reason / BuckleScript bindings for
8-
[`@react-native-community/netinfo`](https://github.com/react-native-community/react-native-netinfo)
9-
(exposed as `ReactNativeNetInfo`).
7+
[ReScript](https://rescript-lang.org) / [Reason](https://reasonml.github.io) bindings for
8+
[`@react-native-community/netinfo`](https://github.com/react-native-netinfo/react-native-netinfo).
109

11-
## Support
10+
Exposed as `ReactNativeNetInfo` module.
1211

13-
`@reason-react-native/netinfo` X.y._ means it's compatible with
14-
`@react-native-community/netinfo` X.y._
15-
16-
| version | react-native version |
17-
| ------- | -------------------- |
18-
| 4.1.0+ | 0.60.0+ |
19-
20-
For 0.59-, you should use
21-
[`jetify -r`](https://github.com/mikehardy/jetifier/blob/master/README.md#to-reverse-jetify--convert-node_modules-dependencies-to-support-libraries).
12+
`@reason-react-native/netinfo` X.y.\* means it's compatible with
13+
`@react-native-community/netinfo` X.y.\*
2214

2315
## Installation
2416

25-
With `yarn`:
26-
27-
```console
28-
yarn add @reason-react-native/netinfo
29-
```
30-
31-
With `npm`:
17+
When
18+
[`@react-native-community/netinfo`](https://github.com/react-native-netinfo/react-native-netinfo)
19+
is properly installed & configured by following their installation instructions,
20+
you can install the bindings:
3221

3322
```console
3423
npm install @reason-react-native/netinfo
24+
# or
25+
yarn add @reason-react-native/netinfo
3526
```
3627

37-
If you use React Native 0.60, `@react-native-community/netinfo` should be linked
38-
to your project:
39-
40-
```console
41-
react-native link @react-native-community/netinfo
42-
```
43-
44-
Finally, `@reason-react-native/netinfo` should be added to `bs-dependencies` in
45-
`BuckleScript` configuration of the project (`bsconfig.json`). For example:
28+
`@reason-react-native/netinfo` should be added to `bs-dependencies` in your
29+
`bsconfig.json`:
4630

4731
```diff
4832
{
4933
//...
5034
"bs-dependencies": [
5135
"reason-react",
5236
"reason-react-native",
37+
// ...
5338
+ "@reason-react-native/netinfo"
5439
],
5540
//...

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
"author": "sgny (https://github.com/sgny)",
1212
"license": "MIT",
1313
"keywords": [
14+
"rescript",
1415
"reason",
1516
"reasonml",
1617
"bucklescript",

0 commit comments

Comments
 (0)