Skip to content

Commit 6e7032c

Browse files
committed
Adjust things for "ReScript" branding
1 parent 06d99ba commit 6e7032c

File tree

3 files changed

+20
-21
lines changed

3 files changed

+20
-21
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: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,32 @@
1-
# BuckleScript bindings to @react-native-community/picker
1+
# `@reason-react-native/picker`
22

33
[![Build Status](https://github.com/reason-react-native/picker/workflows/Build/badge.svg)](https://github.com/reason-react-native/picker/actions)
4-
[![Version](https://img.shields.io/npm/v/@reason-react-native/picker.svg)](https://www.npmjs.com/package/@reason-react-native/picker)
4+
[![Version](https://img.shields.io/npm/v/@reason-react-native/picker.svg)](https://www.npmjs.com/@reason-react-native/picker)
5+
[![Chat](https://img.shields.io/discord/235176658175262720.svg?logo=discord&colorb=blue)](https://reason-react-native.github.io/discord/)
56

6-
These are complete BuckleScript bindings to
7-
[`@reason-react-native/picker`](https://github.com/react-native-community/react-native-picker),
8-
in Reason syntax.
7+
[ReScript](https://rescript-lang.org) / [Reason](https://reasonml.github.io) bindings for
8+
[`@react-native-picker/picker`](https://github.com/react-native-picker/picker).
99

10-
Version `x.y.z` of `@reason-react-native/picker` should be compatible with
11-
version `x.y.*` of `@react-native-community/picker`.
10+
Exposed as `ReactNativePicker` module.
1211

13-
## Installation
14-
15-
With `yarn`:
12+
`@reason-react-native/picker` X.y.\* means it's compatible with
13+
`@react-native-picker/picker` X.y.\*
1614

17-
```shell
18-
yarn add @reason-react-native/picker
19-
```
15+
## Installation
2016

21-
With `npm`:
17+
When
18+
[`@react-native-picker/picker`](https://github.com/react-native-picker/picker)
19+
is properly installed & configured by following their installation instructions,
20+
you can install the bindings:
2221

23-
```shell
22+
```console
2423
npm install @reason-react-native/picker
24+
# or
25+
yarn add @reason-react-native/picker
2526
```
2627

27-
`@react-native-community/picker` should be properly installed and linked. Please
28-
refer to the relevant
29-
[instructions](https://github.com/react-native-community/react-native-picker/blob/master/README.md).
30-
31-
`@reason-react-native/picker` should be added to `bs-dependencies` in your `bsconfig.json`. Something like
28+
`@reason-react-native/picker` should be added to `bs-dependencies` in your
29+
`bsconfig.json`:
3230

3331
```diff
3432
{

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
"repository": "https://github.com/reason-react-native/picker.git",
1111
"license": "MIT",
1212
"keywords": [
13+
"rescript",
1314
"reason",
1415
"reasonml",
1516
"bucklescript",

0 commit comments

Comments
 (0)