react-native-ota-client 0.3.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +17 -4
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,9 +1,22 @@
1
1
  # react-native-ota-client
2
2
 
3
+ [![npm version](https://img.shields.io/npm/v/react-native-ota-client.svg)](https://www.npmjs.com/package/react-native-ota-client)
4
+ [![Documentation](https://img.shields.io/badge/docs-docs.ota.arjunis.me-blue)](https://docs.ota.arjunis.me)
5
+
3
6
  Android and iOS OTA update support for React Native applications using the New Architecture and Hermes. The SDK checks for signed releases, verifies the release manifest and packaged bundle, stages verified updates, selects the bundle on cold start, and rolls back a release that does not confirm healthy.
4
7
 
5
8
  OTA can update JavaScript and bundled assets. Native code, permissions/entitlements, React Native/Hermes versions, and Codegen contract changes require a new APK/IPA.
6
9
 
10
+ ## Documentation
11
+
12
+ Full setup and API guides are at [docs.ota.arjunis.me](https://docs.ota.arjunis.me).
13
+
14
+ - [Installation](https://docs.ota.arjunis.me/guide/installation)
15
+ - [JavaScript API](https://docs.ota.arjunis.me/guide/javascript-api)
16
+ - [Android setup](https://docs.ota.arjunis.me/guide/android)
17
+ - [iOS setup](https://docs.ota.arjunis.me/guide/ios)
18
+ - [Server contract](https://docs.ota.arjunis.me/server)
19
+
7
20
  ## Requirements and support
8
21
 
9
22
  - Android and iOS.
@@ -128,10 +141,10 @@ Use HTTPS for staging and production, with `allowInsecureHttp = false`. Local de
128
141
 
129
142
  `OtaSdkUpdates` exposes the Android startup and host integration API:
130
143
 
131
- - `initialize(context, config)` — configure the manager once before use.
132
- - `beginProcess()` — select/rollback the startup bundle before React Native starts.
133
- - `bundlePathForReactHost()` — return the selected bundle path, or `null` for the APK bundle.
134
- - `status()`, `checkForUpdate()`, `markHealthy()`, and `closeAppForUpdate(activity)` — operations used by the TurboModule implementation.
144
+ - `initialize(context, config)` configures the manager once before use.
145
+ - `beginProcess()` selects or rolls back the startup bundle before React Native starts.
146
+ - `bundlePathForReactHost()` returns the selected bundle path, or `null` for the APK bundle.
147
+ - `status()`, `checkForUpdate()`, `markHealthy()`, and `closeAppForUpdate(activity)` are the operations used by the TurboModule implementation.
135
148
 
136
149
  The SDK autolinks a single `OtaSdkPackage` containing both the sample `OtaSdk` TurboModule and the OTA `OTAUpdates` TurboModule. Do not add another manual package registration in the host app.
137
150
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "react-native-ota-client",
3
- "version": "0.3.0",
3
+ "version": "0.3.1",
4
4
  "description": "Android and iOS OTA updates and over-the-air JavaScript updates for React Native apps",
5
5
  "main": "./lib/module/index.js",
6
6
  "types": "./lib/typescript/src/index.d.ts",
@@ -61,7 +61,7 @@
61
61
  "bugs": {
62
62
  "url": "https://github.com/arjunnarangali/react-native-ota-client/issues"
63
63
  },
64
- "homepage": "https://github.com/arjunnarangali/react-native-ota-client#readme",
64
+ "homepage": "https://docs.ota.arjunis.me/",
65
65
  "publishConfig": {
66
66
  "registry": "https://registry.npmjs.org/"
67
67
  },