Skip to content

Commit a68e783

Browse files
committed
docs: update compatibility and installation documentation for version 2.x
- Added a note that version 2.x requires Nitro 0.35.0 or newer. - Clarified compatibility details in the migration guide and installation instructions. - Updated installation commands to reflect version requirements for `react-native-nitro-modules`. - Enhanced documentation for better clarity on upgrading from v1.x to v2.0.0.
1 parent 6a07368 commit a68e783

File tree

4 files changed

+32
-30
lines changed

4 files changed

+32
-30
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ if (await VersionCheck.needsUpdate()) {
3838
bun add react-native-nitro-version-check
3939
```
4040

41+
> **Version 2.x and newer requires Nitro 0.35+** — for earlier versions, use version 1.x
42+
>
4143
> Check the [full installation guide](https://alshehriali0.github.io/react-native-nitro-version-check/docs/installation) for platform setup and additional dependencies.
4244
4345
## Documentation

docs/docs/compatibility.md

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -11,45 +11,41 @@ This page documents the compatibility between different versions of `react-nativ
1111

1212
| `react-native-nitro-version-check` Version | `react-native-nitro-modules` | Status |
1313
|---|---|---|
14-
| v1.0.x | 0.32.0 - 0.34.x | Stable |
15-
| v1.1.0+ | 0.35.0+ | Current |
14+
| v1.x | 0.32.0 - 0.34.x | Stable |
15+
| v2.0.0+ | 0.35.0+ | Current |
1616

17-
## Nitro 0.35.0 Breaking Changes
17+
## Nitro 0.35.0 and Later
1818

19-
Starting with **v1.1.0**, this library requires [Nitro 0.35.0](https://github.com/mrousavy/nitro/releases/tag/v0.35.0) or later.
19+
**Version 2.x and newer is fully built around Nitro 0.35+ support.** All v1.x versions work with Nitro 0.32.0 - 0.34.x.
2020

21-
### What Changed
21+
### Nitro 0.35.0 Improvements
2222

23-
Nitro 0.35.0 includes a critical memory leak fix in Kotlin HybridObjects. This required changes to:
23+
Nitro 0.35.0 includes critical improvements and a memory leak fix in Kotlin HybridObjects. This required changes to:
2424

2525
- **Kotlin**: Regenerated specs with updated JNI initialization
26-
- **Swift & C++**: No breaking changes, specs regenerated for compatibility
26+
- **Swift & C++**: Specs regenerated for compatibility
2727

28-
### Migration Path
28+
Version 2.x and newer leverage these improvements for better performance and stability.
2929

30-
If you're using v1.0.x and want to upgrade to v1.1.0:
30+
### Upgrading from v1.x to v2.0.0+
3131

32-
1. Ensure you have `react-native-nitro-modules` 0.35.0+:
33-
```sh
34-
bun add react-native-nitro-modules@latest
35-
```
32+
When you're ready to upgrade to v2.0.0, ensure you have `react-native-nitro-modules` 0.35.0+:
3633

37-
2. Update `react-native-nitro-version-check`:
38-
```sh
39-
bun add react-native-nitro-version-check@latest
40-
```
34+
```sh
35+
bun add react-native-nitro-modules@0.35.0
36+
bun add react-native-nitro-version-check@2.0.0
37+
```
4138

42-
3. Rebuild your app:
43-
```sh
44-
# For Expo
45-
bunx expo prebuild --clean
39+
Then rebuild your app:
4640

47-
# For bare React Native
48-
cd ios && pod install
49-
```
41+
```sh
42+
# For Expo
43+
bunx expo prebuild --clean
5044

51-
## Staying on v1.0.x
45+
# For bare React Native
46+
cd ios && pod install
47+
```
5248

53-
If you need to stay on v1.0.x, no action is required. v1.0.x remains compatible with `react-native-nitro-modules` 0.32.0 - 0.34.x.
49+
### Staying on v1.x
5450

55-
However, we recommend upgrading to v1.1.0+ to benefit from the memory leak fixes and improvements in Nitro 0.35.0.
51+
All v1.x versions work with Nitro 0.32.0 - 0.34.x. When you upgrade to Nitro 0.35.0+, you'll need to upgrade to v2.0.0+.

docs/docs/installation.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ bun add react-native-nitro-version-check
1414
```
1515

1616
> Or use your preferred package manager (`npm`, `yarn`, etc.)
17+
>
18+
> **Version 2.x and newer requires Nitro 0.35.0+** — for earlier versions, see [Compatibility](/docs/compatibility)
1719
1820
### Nitro Modules
1921

@@ -44,8 +46,8 @@ cd ios && pod install
4446
## Requirements
4547

4648
- React Native 0.76+
47-
- [`react-native-nitro-modules`](https://github.com/mrousavy/nitro) >= 0.35.0 (for v1.1.0+)
48-
- [`react-native-nitro-modules`](https://github.com/mrousavy/nitro) >= 0.32.0 (for v1.0.x)
49+
- **v2.x+**: [`react-native-nitro-modules`](https://github.com/mrousavy/nitro) >= 0.35.0
50+
- **v1.x**: [`react-native-nitro-modules`](https://github.com/mrousavy/nitro) >= 0.32.0
4951

5052
> See the [Compatibility](/docs/compatibility) guide to understand version requirements and migration paths.
5153

docs/docs/migration-guide.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ Remove the old package and install the new one:
1616
npm uninstall react-native-version-check
1717

1818
# Install new
19-
bun add react-native-nitro-version-check react-native-nitro-modules
19+
bun add react-native-nitro-version-check react-native-nitro-modules@latest
2020
```
2121

22+
> **Nitro Version Requirement**: Version 2.x requires `react-native-nitro-modules` >= 0.35.0. See the [Compatibility guide](/docs/compatibility) for version-specific requirements.
23+
2224
## 2. Update imports
2325

2426
```ts

0 commit comments

Comments
 (0)