From 9b93685a5bfd5e16038328335c8e0ff95f0fdbbe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kr=C3=A6n=20Hansen?= Date: Tue, 17 Jun 2025 13:44:03 +0200 Subject: [PATCH 1/2] Update READMEs --- packages/cmake-rn/README.md | 2 +- packages/ferric/README.md | 3 ++ packages/host/README.md | 22 ++++++++++++-- packages/host/logo.svg | 58 +++++++++++++++++++++++++++++++++++++ packages/host/package.json | 1 + 5 files changed, 83 insertions(+), 3 deletions(-) create mode 100644 packages/ferric/README.md create mode 100644 packages/host/logo.svg diff --git a/packages/cmake-rn/README.md b/packages/cmake-rn/README.md index 1f37f269..6bd9051b 100644 --- a/packages/cmake-rn/README.md +++ b/packages/cmake-rn/README.md @@ -1,5 +1,5 @@ # `cmake-rn` -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). +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). Serves the same purpose as `cmake-js` does for the Node.js community and could potentially be upstreamed into `cmake-js` eventually. diff --git a/packages/ferric/README.md b/packages/ferric/README.md new file mode 100644 index 00000000..c61bdb9a --- /dev/null +++ b/packages/ferric/README.md @@ -0,0 +1,3 @@ +# `ferric` + +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. diff --git a/packages/host/README.md b/packages/host/README.md index cecc71dc..00c88622 100644 --- a/packages/host/README.md +++ b/packages/host/README.md @@ -1,3 +1,21 @@ -# Node-API Modules for React Native +

+ +

-Write once, run anywhere: Build native modules for [React Native](https://reactnative.dev/) with [Node-API](https://nodejs.org/api/n-api.html). +

+ Node-API Modules
for React Native +

+ +

+ Write once, run anywhere:
+ Build native modules for React Native with Node-API. +

+ +## Getting started + +> [!WARNING] +> This library is still under active development. Feel free to hack around, but use at your own risk. + +``` +npm install react-native-node-api +``` diff --git a/packages/host/logo.svg b/packages/host/logo.svg new file mode 100644 index 00000000..a486cad3 --- /dev/null +++ b/packages/host/logo.svg @@ -0,0 +1,58 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/host/package.json b/packages/host/package.json index 510eecc4..3a43bbd6 100644 --- a/packages/host/package.json +++ b/packages/host/package.json @@ -23,6 +23,7 @@ "./weak-node-api": "./weak-node-api" }, "files": [ + "logo.svg", "bin", "dist", "cpp", From e8940e7c9fb3e433ad174bc434ed5bcb94d49da1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kr=C3=A6n=20Hansen?= Date: Tue, 17 Jun 2025 13:48:08 +0200 Subject: [PATCH 2/2] Flipping gyp-to-cmake from private to public --- packages/gyp-to-cmake/package.json | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/gyp-to-cmake/package.json b/packages/gyp-to-cmake/package.json index 87246480..a320ac44 100644 --- a/packages/gyp-to-cmake/package.json +++ b/packages/gyp-to-cmake/package.json @@ -1,7 +1,6 @@ { "name": "gyp-to-cmake", "version": "0.1.0", - "private": true, "description": "Convert binding.gyp files to CMakeLists.txt", "homepage": "https://github.com/callstackincubator/react-native-node-api", "repository": {