Skip to content

Commit 491f9ea

Browse files
committed
chore: update readme
1 parent 4cdd95d commit 491f9ea

1 file changed

Lines changed: 25 additions & 14 deletions

File tree

README.md

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -133,25 +133,36 @@ Use `'deferred-only'` when Expo Router's `+native-intent.tsx` handler is already
133133

134134
All example apps with Detour SDK integrated live in `examples/`:
135135

136-
- `examples/expo-bare`
137-
- `examples/expo-router`
138-
- `examples/expo-router-native-intent`
139-
- `examples/expo-router-advanced`
140-
- `examples/react-navigation`
141-
- `examples/react-navigation-advanced`
136+
| Example | Description |
137+
|---|---|
138+
| `examples/expo-router` | Minimal Expo Router example (recommended starting point) |
139+
| `examples/expo-router-native-intent` | Expo Router with `+native-intent` handler |
140+
| `examples/expo-router-advanced` | Expo Router with auth flow and protected routes |
141+
| `examples/expo-bare` | Expo without file-based routing (plain `index.js` entry point) |
142+
| `examples/react-navigation` | React Navigation example |
143+
| `examples/react-navigation-advanced` | React Navigation with auth flow |
142144

143-
You can run them from repo root:
145+
The monorepo uses **pnpm**. Run examples from the repo root:
144146

145147
```sh
146-
yarn examples:expo-bare start
147-
yarn examples:expo-router start
148-
yarn examples:expo-router-native-intent start
149-
yarn examples:expo-router-advanced start
150-
yarn examples:react-navigation start
151-
yarn examples:react-navigation-advanced start
148+
pnpm examples:expo-router ios
149+
pnpm examples:expo-router android
150+
pnpm examples:expo-router-native-intent ios
151+
pnpm examples:expo-router-advanced ios
152+
pnpm examples:expo-bare ios
153+
pnpm examples:react-navigation ios
154+
pnpm examples:react-navigation-advanced ios
152155
```
153156

154-
If you want to know more details about a given example and how to configure it, please read the README in the appropriate example directory.
157+
Or navigate directly to an example directory:
158+
159+
```sh
160+
cd examples/expo-router
161+
pnpm ios
162+
pnpm android
163+
```
164+
165+
> Running `pnpm ios` / `pnpm android` produces a development build. This is recommended over Expo Go for testing deep linking flows on a real device.
155166
156167
## Clearing handled links
157168

0 commit comments

Comments
 (0)