Skip to content

Commit aa970c2

Browse files
committed
docs: add new README.md file for the example app
1 parent a3076da commit aa970c2

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

example/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Example App
2+
3+
A demo app showcasing all features of `react-native-nitro-version-check`.
4+
5+
## Prerequisites
6+
7+
- [Bun](https://bun.sh)
8+
- [Expo CLI](https://docs.expo.dev/get-started/set-up-your-environment/)
9+
- Xcode (for iOS) or Android Studio (for Android)
10+
11+
## Getting Started
12+
13+
```sh
14+
# 1. Install dependencies from the monorepo root
15+
cd ..
16+
bun install
17+
18+
# 2. Generate native projects
19+
cd example
20+
npx expo prebuild
21+
22+
# 3. Run the app
23+
bun run ios # iOS
24+
bun run android # Android
25+
```
26+
27+
## Available Scripts
28+
29+
| Script | Description |
30+
|--------|-------------|
31+
| `bun start` | Start the Expo dev server |
32+
| `bun run ios` | Build and run on iOS simulator |
33+
| `bun run android` | Build and run on Android emulator |
34+
| `bun run web` | Start the web version |

0 commit comments

Comments
 (0)