Skip to content

Commit c7531b9

Browse files
committed
add READMEs for each package
1 parent 0f03aa0 commit c7531b9

File tree

3 files changed

+37
-0
lines changed

3 files changed

+37
-0
lines changed

packages/ios/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# @nativescript/ios-node-api
2+
3+
An embeddable, engine-agnostic NativeScript runtime for iOS based on Node-API.
4+
5+
## Installation
6+
7+
These steps assume that you're making an iOS app that includes a Node-API-capable JavaScript runtime and manages its JS dependencies using npm (or similar package managers).
8+
9+
First, install the npm package:
10+
11+
```sh
12+
npm install @nativescript/ios-node-api
13+
```
14+
15+
Next, embed the xcframework provided at `build/ios-universal/NativeScript.xcframework` into your iOS app. For convenience, we provide `NativeScript.podspec` so that you can link it as a local podspec. For React Native (or Expo) apps, this will be autolinked.
16+
17+
## Usage
18+
19+
Until we have some example projects to provide, a few example usages in an Expo app are shown in this [tweet](https://x.com/birch_js/status/1773401773266604240).

packages/macos/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# @nativescript/macos-node-api
2+
3+
An embeddable, engine-agnostic NativeScript runtime for macOS based on Node-API.
4+
5+
## Installation
6+
7+
```sh
8+
npm install @nativescript/macos-node-api
9+
```
10+
11+
## Usage
12+
13+
See [examples](https://github.com/DjDeveloperr/runtime/tree/main/examples) in the repo. Best run on Node.js for now.

packages/objc/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# @nativescript/objc-node-api
2+
3+
Typings for the common Objective-C runtime APIs used by both `@nativescript/ios-node-api` and `@nativescript/macos-node-api`.
4+
5+
This is intended to be used as a subdependency of the aforementioned packages, so please consult their documentation.

0 commit comments

Comments
 (0)