Merge pull request #2 from AlshehriAli0/nitro-0.35-upgrade

Author: AlshehriAli0

README.md

@@ -38,13 +38,16 @@ if (await VersionCheck.needsUpdate()) {
 bun add react-native-nitro-version-check
 ```
 
+> **Version 2.x and newer requires Nitro 0.35+** — for earlier versions, use version 1.x
+>
 > Check the [full installation guide](https://alshehriali0.github.io/react-native-nitro-version-check/docs/installation) for platform setup and additional dependencies.
 
 ## Documentation
 
 - [**Nitro Version Check** docs 📚](https://alshehriali0.github.io/react-native-nitro-version-check/)
 - [**Getting Started** guide](https://alshehriali0.github.io/react-native-nitro-version-check/docs/getting-started)
 - [**Installation** guide](https://alshehriali0.github.io/react-native-nitro-version-check/docs/installation)
+- [**Compatibility** guide](https://alshehriali0.github.io/react-native-nitro-version-check/docs/compatibility)
 - [**API Reference**](https://alshehriali0.github.io/react-native-nitro-version-check/docs/api-reference)
 - [**Migration Guide** from react-native-version-check](https://alshehriali0.github.io/react-native-nitro-version-check/docs/migration-guide)
 

bun.lock

@@ -0,0 +1,51 @@
+---
+sidebar_position: 3
+title: Compatibility
+---
+
+# Compatibility
+
+This page documents the compatibility between different versions of `react-native-nitro-version-check` and the Nitro ecosystem.
+
+## Version Matrix
+
+| `react-native-nitro-version-check` Version | `react-native-nitro-modules` | Status |
+|---|---|---|
+| v1.x | 0.32.0 - 0.34.x | Stable |
+| v2.0.0+ | 0.35.0+ | Current |
+
+## Nitro 0.35.0 and Later
+
+**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.
+
+### Nitro 0.35.0 Improvements
+
+Nitro 0.35.0 includes critical improvements and a memory leak fix in Kotlin HybridObjects. This required changes to:
+
+- **Kotlin**: Regenerated specs with updated JNI initialization
+- **Swift & C++**: Specs regenerated for compatibility
+
+Version 2.x and newer leverage these improvements for better performance and stability.
+
+### Upgrading from v1.x to v2.0.0+
+
+When you're ready to upgrade to v2.0.0, ensure you have `react-native-nitro-modules` 0.35.0+:
+
+```sh
+bun add react-native-nitro-modules@0.35.0
+bun add react-native-nitro-version-check@2.0.0
+```
+
+Then rebuild your app:
+
+```sh
+# For Expo
+bunx expo prebuild --clean
+
+# For bare React Native
+cd ios && pod install
+```
+
+### Staying on v1.x
+
+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/compatibility.md

@@ -42,15 +42,15 @@ bun install
 
 ```sh
 cd example
-npx expo prebuild
+bunx expo prebuild
 bun run ios
 ```
 
 ### Android
 
 ```sh
 cd example
-npx expo prebuild
+bunx expo prebuild
 bun run android
 ```
 

docs/docs/contributing.md

@@ -5,7 +5,7 @@ title: Getting Started
 
 # Getting Started
 
-**react-native-nitro-version-check** is a lightweight, fast version-checking library for React Native, powered by [Nitro Modules](https://github.com/mrousavy/nitro).
+`react-native-nitro-version-check` is a lightweight, fast version-checking library for React Native, powered by [Nitro Modules](https://github.com/mrousavy/nitro).
 
 It's a drop-in replacement for the unmaintained [`react-native-version-check`](https://github.com/kimxogus/react-native-version-check) — rewritten from scratch for performance.
 

docs/docs/getting-started.md

@@ -14,10 +14,12 @@ bun add react-native-nitro-version-check
 ```
 
 > Or use your preferred package manager (`npm`, `yarn`, etc.)
+>
+> **Version 2.x and newer requires Nitro 0.35.0+** — for earlier versions, see [Compatibility](/docs/compatibility)
 
 ### Nitro Modules
 
-This library requires [react-native-nitro-modules](https://github.com/mrousavy/nitro). If you don't already have it installed, add it:
+This library requires [`react-native-nitro-modules`](https://github.com/mrousavy/nitro). If you don't already have it installed, add it:
 
 ```sh
 bun add react-native-nitro-modules
@@ -30,7 +32,7 @@ bun add react-native-nitro-modules
 For Expo projects, run prebuild after installing:
 
 ```sh
-npx expo prebuild
+bunx expo prebuild
 ```
 
 ### Bare React Native
@@ -44,7 +46,10 @@ cd ios && pod install
 ## Requirements
 
 - React Native 0.76+
-- [react-native-nitro-modules](https://github.com/mrousavy/nitro) >= 0.32.0
+- **v2.x+**: [`react-native-nitro-modules`](https://github.com/mrousavy/nitro) >= 0.35.0
+- **v1.x**: [`react-native-nitro-modules`](https://github.com/mrousavy/nitro) >= 0.32.0
+
+> See the [Compatibility](/docs/compatibility) guide to understand version requirements and migration paths.
 
 ## Verify installation
 

docs/docs/installation.md

@@ -16,9 +16,11 @@ Remove the old package and install the new one:
 npm uninstall react-native-version-check
 
 # Install new
-bun add react-native-nitro-version-check react-native-nitro-modules
+bun add react-native-nitro-version-check react-native-nitro-modules@latest
 ```
 
+> **Nitro Version Requirement**: Version 2.x requires `react-native-nitro-modules` >= 0.35.0. See the [Compatibility guide](/docs/compatibility) for version-specific requirements.
+
 ## 2. Update imports
 
 ```ts
@@ -93,7 +95,7 @@ These are new and have no equivalent in the old library:
 For Expo:
 
 ```sh
-npx expo prebuild --clean
+bunx expo prebuild --clean
 ```
 
 For bare React Native:

docs/docs/migration-guide.md

@@ -5,7 +5,7 @@ const sidebars: SidebarsConfig = {
     {
       type: "category",
       label: "Getting Started",
-      items: ["getting-started", "installation"],
+      items: ["getting-started", "installation", "compatibility"],
     },
     {
       type: "category",

docs/sidebars.ts

@@ -17,7 +17,7 @@ bun install
 
 # 2. Generate native projects
 cd example
-npx expo prebuild
+bunx expo prebuild
 
 # 3. Run the app
 bun run ios      # iOS