Skip to content

Commit 9b93685

Browse files
committed
Update READMEs
1 parent 3de8033 commit 9b93685

File tree

5 files changed

+83
-3
lines changed

5 files changed

+83
-3
lines changed

packages/cmake-rn/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# `cmake-rn`
22

3-
A wrapper around CMake making it easier to produce [prebuilt binaries](./docs/PREBUILDS.md) targeting iOS and Android matching the [the prebuilt binary specification](./docs/PREBUILDS.md).
3+
A wrapper around Cmake making it easier to produce prebuilt binaries targeting iOS and Android matching the [the prebuilt binary specification](https://github.com/callstackincubator/react-native-node-api/blob/main/docs/PREBUILDS.md).
44

55
Serves the same purpose as `cmake-js` does for the Node.js community and could potentially be upstreamed into `cmake-js` eventually.

packages/ferric/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# `ferric`
2+
3+
A wrapper around Cargo making it easier to produce prebuilt binaries targeting iOS and Android matching the [the prebuilt binary specification](https://github.com/callstackincubator/react-native-node-api/blob/main/docs/PREBUILDS.md) as well as [napi.rs](https://napi.rs/) to generate bindings from annotated Rust code.

packages/host/README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1-
# Node-API Modules for React Native
1+
<p align="center">
2+
<img src="./logo.svg" width="20%" />
3+
</p>
24

3-
Write once, run anywhere: Build native modules for [React Native](https://reactnative.dev/) with [Node-API](https://nodejs.org/api/n-api.html).
5+
<h1 align="center">
6+
Node-API Modules<br/>for React Native
7+
</h1>
8+
9+
<p align="center">
10+
<strong>Write once, run anywhere:</strong><br/>
11+
Build native modules for <a href="https://reactnative.dev/">React Native</a> with <a href="https://nodejs.org/api/n-api.html">Node-API</a>.
12+
</p>
13+
14+
## Getting started
15+
16+
> [!WARNING]
17+
> This library is still under active development. Feel free to hack around, but use at your own risk.
18+
19+
```
20+
npm install react-native-node-api
21+
```

packages/host/logo.svg

Lines changed: 58 additions & 0 deletions
Loading

packages/host/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
"./weak-node-api": "./weak-node-api"
2424
},
2525
"files": [
26+
"logo.svg",
2627
"bin",
2728
"dist",
2829
"cpp",

0 commit comments

Comments
 (0)