Skip to content

Commit 6a07368

Browse files
committed
docs: update documentation for compatibility and installation instructions
- Clarified compatibility details for `react-native-nitro-modules`. - Updated installation instructions to use `bunx` instead of `npx` for Expo prebuild commands. - Enhanced the getting started guide with code formatting for library names. - Minor adjustments to ensure consistency in documentation formatting.
1 parent e44beac commit 6a07368

File tree

7 files changed

+38
-104
lines changed

7 files changed

+38
-104
lines changed

bun.lock

Lines changed: 20 additions & 88 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/docs/compatibility.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ title: Compatibility
55

66
# Compatibility
77

8-
This page documents the compatibility between different versions of react-native-nitro-version-check and the Nitro ecosystem.
8+
This page documents the compatibility between different versions of `react-native-nitro-version-check` and the Nitro ecosystem.
99

1010
## Version Matrix
1111

12-
| Library Version | Nitro Modules | Status |
12+
| `react-native-nitro-version-check` Version | `react-native-nitro-modules` | Status |
1313
|---|---|---|
1414
| v1.0.x | 0.32.0 - 0.34.x | Stable |
1515
| v1.1.0+ | 0.35.0+ | Current |
@@ -29,27 +29,27 @@ Nitro 0.35.0 includes a critical memory leak fix in Kotlin HybridObjects. This r
2929

3030
If you're using v1.0.x and want to upgrade to v1.1.0:
3131

32-
1. Ensure you have Nitro modules 0.35.0+:
32+
1. Ensure you have `react-native-nitro-modules` 0.35.0+:
3333
```sh
3434
bun add react-native-nitro-modules@latest
3535
```
3636

37-
2. Update the library:
37+
2. Update `react-native-nitro-version-check`:
3838
```sh
3939
bun add react-native-nitro-version-check@latest
4040
```
4141

4242
3. Rebuild your app:
4343
```sh
4444
# For Expo
45-
npx expo prebuild --clean
45+
bunx expo prebuild --clean
4646

4747
# For bare React Native
48-
cd ios && pod install && cd ..
48+
cd ios && pod install
4949
```
5050

5151
## Staying on v1.0.x
5252

53-
If you need to stay on v1.0.x, no action is required. v1.0.x remains compatible with Nitro 0.32.0 - 0.34.x.
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.
5454

5555
However, we recommend upgrading to v1.1.0+ to benefit from the memory leak fixes and improvements in Nitro 0.35.0.

docs/docs/contributing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,15 @@ bun install
4242

4343
```sh
4444
cd example
45-
npx expo prebuild
45+
bunx expo prebuild
4646
bun run ios
4747
```
4848

4949
### Android
5050

5151
```sh
5252
cd example
53-
npx expo prebuild
53+
bunx expo prebuild
5454
bun run android
5555
```
5656

docs/docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Getting Started
55

66
# Getting Started
77

8-
**react-native-nitro-version-check** is a lightweight, fast version-checking library for React Native, powered by [Nitro Modules](https://github.com/mrousavy/nitro).
8+
`react-native-nitro-version-check` is a lightweight, fast version-checking library for React Native, powered by [Nitro Modules](https://github.com/mrousavy/nitro).
99

1010
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.
1111

docs/docs/installation.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ bun add react-native-nitro-version-check
1717
1818
### Nitro Modules
1919

20-
This library requires [react-native-nitro-modules](https://github.com/mrousavy/nitro). If you don't already have it installed, add it:
20+
This library requires [`react-native-nitro-modules`](https://github.com/mrousavy/nitro). If you don't already have it installed, add it:
2121

2222
```sh
2323
bun add react-native-nitro-modules
@@ -30,7 +30,7 @@ bun add react-native-nitro-modules
3030
For Expo projects, run prebuild after installing:
3131

3232
```sh
33-
npx expo prebuild
33+
bunx expo prebuild
3434
```
3535

3636
### Bare React Native
@@ -44,8 +44,10 @@ cd ios && pod install
4444
## Requirements
4545

4646
- 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)
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+
50+
> See the [Compatibility](/docs/compatibility) guide to understand version requirements and migration paths.
4951
5052
## Verify installation
5153

docs/docs/migration-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ These are new and have no equivalent in the old library:
9393
For Expo:
9494

9595
```sh
96-
npx expo prebuild --clean
96+
bunx expo prebuild --clean
9797
```
9898

9999
For bare React Native:

example/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ bun install
1717

1818
# 2. Generate native projects
1919
cd example
20-
npx expo prebuild
20+
bunx expo prebuild
2121

2222
# 3. Run the app
2323
bun run ios # iOS

0 commit comments

Comments
 (0)