refactor: changes after CR

Author: artus9033

README.md

@@ -27,6 +27,10 @@
 
 See the document on ["how it works"](./docs/HOW-IT-WORKS.md) for a detailed description of what it's like to write native modules using this package.
 
+### Quick start
+
+To get started, first install the dependencies with `npm i` and then build all packages using `npm run build`.
+
 ## Packages
 
 This mono-repository hosts the development of a few packages:

apps/test-app/android/settings.gradle

@@ -21,5 +21,5 @@ apply(from: {
 applyTestAppSettings(settings)
 
 // customize the path to match your node_modules location
-apply(from: "../../../node_modules/react-native-node-api/android/consumerSettings.gradle")
+apply(from: "../../../node_modules/react-native-node-api/android/app-settings.gradle")
 applyNodeAPISettings(settings)

docs/ANDROID.md

@@ -1,35 +1,33 @@
 # Android support
 
-## Android setup
+## Building Hermes from source
 
 ### Step 1: `settings.gradle`
 
-Gradle needs special handling to build React Native from source. In your app's `settings.gradle` please include the below:
+Gradle needs specific configuration to build React Native from source: dependency substitutions for React Native & Hermes modules, and modifications to default logic in RN build scripts, which is done by setting an environment variable, as described in this section.
+
+In your app's `settings.gradle` please include the below:
 
 ```groovy
 // customize the path to match your node_modules location
-apply(from: "../../../node_modules/react-native-node-api/android/consumerSettings.gradle")
+apply(from: "../../../node_modules/react-native-node-api/android/app-settings.gradle")
 applyNodeAPISettings(settings)
 ```
 
 ### Step 2: script for adjusting environment variables
 
-To integrate automatic setup of Hermes engine, a special env variable (`REACT_NATIVE_OVERRIDE_HERMES_DIR`) must be set to a proper path. Since Gradle does not really support loading `.env` files, this must be automated by the consumer. We provide the script `react-native-node-api vendor-hermes --silent` which will output a single line, the path to Hermes directory.
-
-Each time you run Android Studio, make sure this is in place.
-
-### How it works: building Hermes from source
+> [!IMPORTANT]
+> Each time you run Android Studio or build the Android app from a terminal, make sure the below is in place.
 
-Because we're using a version of Hermes patched with Node-API support, we need to build React Native from source.
+Because we're using a version of Hermes patched with Node-API support, we need to build React Native from source. A special environment variable (`REACT_NATIVE_OVERRIDE_HERMES_DIR`) must be set to the path of a Hermes engine with Node-API support. Since Gradle does not support loading `.env` files directly, this must be automated by the consumer. We provide the `react-native-node-api vendor-hermes --silent` command, which will download Hermes and output the path to Hermes directory path as its only output.
 
-Alternatively, if for whatever reason you want to do it manually, you can do so by exporting this environment variable before Gradle invocation:
+You can configure the environment variable using the following command:
 
 ```
 export REACT_NATIVE_OVERRIDE_HERMES_DIR="$(npx react-native-node-api vendor-hermes --silent)"
 ```
 
-> [!TIP]
-> This above automatically done by our script. If you run it from postinstall, there is no need to do this manually.
+This either needs to be done each time before Gradle / Android Studio invocation, or permanently in a shell init script such as `~/.zshrc` on Zsh (MacOS) or `~/.bashrc` on Bash (Linux).
 
 ## Cleaning your React Native build folders
 

docs/IOS.md

@@ -1,7 +1,3 @@
 # iOS support
 
-## iOS setup: script for adjusting environment variables
-
-To integrate automatic setup of Hermes engine, a special env variable (`REACT_NATIVE_OVERRIDE_HERMES_DIR`) must be set to a proper path. We provide the script `react-native-node-api vendor-hermes --silent` which will output a single line, the path to Hermes directory.
-
-Each time you run XCode, make sure this is in place.
+Because we're using a version of Hermes patched with Node-API support, we need to build React Native from source. Special environment variables (`REACT_NATIVE_OVERRIDE_HERMES_DIR`, `BUILD_FROM_SOURCE`) must be set to the path of a Hermes engine with Node-API support. The podspec of the iOS Pod already includes instrumentation to configure React Native appropriately via [`patch-hermes.rb`](../packages/host/scripts/patch-hermes.rb).

package-lock.json

@@ -21,8 +21,7 @@
     "test": "npm run test --workspace react-native-node-api --workspace cmake-rn --workspace gyp-to-cmake --workspace node-addon-examples",
     "bootstrap": "npm run build && npm run bootstrap --workspaces --if-present",
     "prerelease": "npm run build && npm run prerelease --workspaces --if-present",
-    "release": "changeset publish",
-    "postinstall": "npm run build"
+    "release": "changeset publish"
   },
   "author": {
     "name": "Callstack",

package.json

@@ -6,7 +6,7 @@ ext.applyNodeAPISettings = { DefaultSettings settings ->
     do {
         def p = searchDirectory.resolve("node_modules/react-native")
         if (p.toFile().exists()) {
-            println "[RN-NAPI] Found React Native in ${p.toRealPath().toString()}"
+            println "[Node-API] !!! PATCHING HERMES WITH NODE-API SUPPORT !!! Found React Native in ${p.toRealPath().toString()}"
 
             includeBuild(p.toRealPath().toString()) {
                 dependencySubstitution {