Skip to content

Commit 6ec62b6

Browse files
committed
Update README.md
1 parent 80bfea9 commit 6ec62b6

1 file changed

Lines changed: 33 additions & 12 deletions

File tree

‎README.md‎

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,31 @@
11
# BuckleScript bindings for React Native
22

3-
[![Build Status][build-badge]][build]
4-
[![Version][version-badge]][package]
3+
[![Build Status][build-badge]][build] [![Version][version-badge]][package]
54
[![React Native][react-native-badge]][react-native]
65
[![All Contributors][all-contributors-badge]][contributors]
76
[![Chat][chat-badge]][chat]
87

9-
[BuckleScript](https://bucklescript.github.io) bindings for [React Native](https://github.com/facebook/react-native) allows to use [ReasonML](https://reasonml.github.io) with [ReasonReact](https://reasonml.github.io/reason-react/) to make your iOS, Android and [Web](https://github.com/necolas/react-native-web) apps.
8+
[BuckleScript](https://bucklescript.github.io) bindings for
9+
[React Native](https://github.com/facebook/react-native) allows to use
10+
[ReasonML](https://reasonml.github.io) with
11+
[ReasonReact](https://reasonml.github.io/reason-react/) to make your iOS,
12+
Android and [Web](https://github.com/necolas/react-native-web) apps.
13+
14+
## 🚨 Usage from Git repo
15+
16+
If you use this bindings from the git repo, be sure to use
17+
18+
`"bs-react-native/bs-react-native"` as a `bs-dependencies` instead if just
19+
`"bs-react-native"`.
1020

1121
## Getting Started
1222

13-
Check our [getting started](https://reasonml-community.github.io/bs-react-native/BsReactNative/gettingstarted.html) guide for details.
23+
Check our
24+
[getting started](https://reasonml-community.github.io/bs-react-native/BsReactNative/gettingstarted.html)
25+
guide for details.
1426

15-
You can run the [playground](./example) with Expo: https://expo.io/@grabbou/bs-react-native.
27+
You can run the [playground](./example) with Expo:
28+
https://expo.io/@grabbou/bs-react-native.
1629

1730
## Documentation
1831

@@ -28,21 +41,29 @@ Read the [contribution guidelines](./CONTRIBUTING.md) before contributing.
2841

2942
## Changelog
3043

31-
Check the [changelog](./CHANGELOG.md) for more informations about recent releases.
44+
Check the [changelog](./CHANGELOG.md) for more informations about recent
45+
releases.
3246

3347
## Code of Conduct
3448

35-
We want this community to be friendly and respectful to each other. Please read [the full text](https://github.com/reasonml-community/bs-react-native/blob/master/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
49+
We want this community to be friendly and respectful to each other. Please read
50+
[the full text](https://github.com/reasonml-community/bs-react-native/blob/master/CODE_OF_CONDUCT.md)
51+
so that you can understand what actions will and will not be tolerated.
3652

3753
<!-- badges -->
3854

39-
[build-badge]: https://img.shields.io/circleci/project/github/reasonml-community/bs-react-native/master.svg
55+
[build-badge]:
56+
https://img.shields.io/circleci/project/github/reasonml-community/bs-react-native/master.svg
4057
[build]: https://circleci.com/gh/reasonml-community/bs-react-native
4158
[version-badge]: https://img.shields.io/npm/v/bs-react-native.svg
4259
[package]: https://www.npmjs.com/package/bs-react-native
43-
[all-contributors-badge]: https://img.shields.io/badge/all_contributors-68-blue.svg
44-
[contributors]: https://github.com/reasonml-community/bs-react-native/blob/master/CONTRIBUTORS.md
45-
[chat-badge]: https://img.shields.io/discord/496273792503513089.svg?logo=discord&colorB=blue
60+
[all-contributors-badge]:
61+
https://img.shields.io/badge/all_contributors-68-blue.svg
62+
[contributors]:
63+
https://github.com/reasonml-community/bs-react-native/blob/master/CONTRIBUTORS.md
64+
[chat-badge]:
65+
https://img.shields.io/discord/496273792503513089.svg?logo=discord&colorB=blue
4666
[chat]: https://discord.gg/q8GQD34
47-
[react-native-badge]: https://img.shields.io/badge/react--native-%5E0.53.3-green.svg
67+
[react-native-badge]:
68+
https://img.shields.io/badge/react--native-%5E0.53.3-green.svg
4869
[react-native]: https://github.com/facebook/react-native

0 commit comments

Comments
 (0)