Skip to content

Commit d367b6e

Browse files
committed
Fix package names in README
1 parent a7b398a commit d367b6e

File tree

4 files changed

+22
-17
lines changed

4 files changed

+22
-17
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ See the document on ["how it works"](./docs/HOW-IT-WORKS.md) for a detailed desc
3131

3232
This mono-repository hosts the development of a few packages:
3333

34-
### `packages/react-native-node-api`
34+
### [`react-native-node-api`](packages/host)
3535

3636
Responsible for adding Node-API support to your React Native application:
3737

@@ -48,22 +48,22 @@ Responsible for adding Node-API support to your React Native application:
4848

4949
Note: We'll sometimes refer to this as the "host package", as it can be seen as a host of Node-API modules in React Native apps.
5050

51-
### `packages/cmake-rn`
51+
### [`cmake-rn`](packages/cmake-rn)
5252

5353
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).
5454

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

57-
### `packages/gyp-to-cmake`
57+
### [`gyp-to-cmake`](packages/gyp-to-cmake)
5858

5959
A tool to transform `binding.gyp` files into `CMakeLists.txt` files, intended for `cmake-js` or `cmake-rn` to build from.
6060

61-
### `packages/node-addon-examples`
61+
### [`@react-native-node-api/node-addon-examples`](packages/node-addon-examples)
6262

6363
A wrapper around the examples in the [nodejs/node-addon-examples](https://github.com/nodejs/node-addon-examples) repo, using `gyp-to-cmake` and `cmake-rn` to prepare prebuilds and scaffolding for loading the addons.
6464

6565
The main purpose is to use these as tests to verify the implementation. We choose to use this as our first signal for compliance, over the [js-native-api tests in the Node.js project](https://github.com/nodejs/node/tree/main/test/js-native-api), because the examples depends much less on Node.js built-in runtime APIs.
6666

67-
### `apps/test-app`
67+
### [`@react-native-node-api/test-app`](apps/test-app)
6868

6969
A test app using `react-native-test-app` to exercise the implementation of

apps/test-app/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "react-native-node-api-test-app",
2+
"name": "@react-native-node-api/test-app",
33
"private": true,
44
"version": "0.1.1",
55
"scripts": {

package-lock.json

Lines changed: 15 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/ferric-example/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "ferric-example",
2+
"name": "@react-native-node-api/ferric-example",
33
"private": true,
44
"version": "0.1.0",
55
"homepage": "https://github.com/callstackincubator/react-native-node-api",

0 commit comments

Comments
 (0)