Skip to content

Commit 13d6fa8

Browse files
authored
docs: improve example app documentation for starting the app (#293)
1 parent 9e29421 commit 13d6fa8

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

example/README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,22 @@ This contains a sample application to showcase the functionality of the NavSDK l
2525
<string>Your API KEY</string>
2626
```
2727

28-
5. To run the sample app, go to the root folder of the sample app and run the command below according to platform using your preferred terminal.
28+
5. To run the sample app, navigate to the `example` folder in the root directory and use the following commands for your platform in the terminal.
2929

30-
* Running in Android:
31-
`npx react-native run-android`
32-
* Running in iOS:
33-
`npx react-native run-ios`
30+
1. Ensure all workspace dependencies are installed:
31+
`yarn install`
3432

33+
2. Start the metro bundler:
34+
* Android:
35+
`npx react-native run-android`
36+
* iOS:
37+
`npx react-native run-ios`
3538

36-
1. After the app initializes, accept the terms of services. You should see a map loaded in background if you have used the right API key.
39+
40+
6. After the app initializes, accept the terms of services. You should see a map loaded in background if you have used the right API key.
3741

3842

3943
### Android
4044
1. On your Emulator, go to App Info for the installed app, then Permissions > Location and allow location for the app.
4145

42-
1. Restart the app, now the Navigation view should be displayed instead of the map.
46+
2. Restart the app, now the Navigation view should be displayed instead of the map.

0 commit comments

Comments
 (0)