@baeckerherz/expo-mapbox-navigation 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -33
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -89,7 +89,19 @@ import { MapboxNavigation } from '@baeckerherz/expo-mapbox-navigation';
|
|
|
89
89
|
| `onUserOffRoute` | — | User went off the planned route. |
|
|
90
90
|
| `onError` | `{ message }` | Navigation error occurred. |
|
|
91
91
|
|
|
92
|
-
##
|
|
92
|
+
## Prerequisites
|
|
93
|
+
|
|
94
|
+
1. A [Mapbox account](https://account.mapbox.com/) with Navigation SDK access
|
|
95
|
+
2. A public access token (`pk.xxx`) and a secret/download token (`sk.xxx`)
|
|
96
|
+
3. For iOS: `~/.netrc` must contain Mapbox credentials for SPM package resolution:
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
machine api.mapbox.com
|
|
100
|
+
login mapbox
|
|
101
|
+
password sk.eyJ1...YOUR_SECRET_TOKEN
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## Installation
|
|
93
105
|
|
|
94
106
|
```bash
|
|
95
107
|
npx expo install @baeckerherz/expo-mapbox-navigation
|
|
@@ -114,15 +126,9 @@ npx expo prebuild --clean
|
|
|
114
126
|
npx expo run:ios
|
|
115
127
|
```
|
|
116
128
|
|
|
117
|
-
##
|
|
129
|
+
## Contributing
|
|
118
130
|
|
|
119
|
-
|
|
120
|
-
cd @baeckerherz/expo-mapbox-navigation
|
|
121
|
-
yarn install
|
|
122
|
-
cd example && npx expo run:ios
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
## Project Structure
|
|
131
|
+
### Project Structure
|
|
126
132
|
|
|
127
133
|
```
|
|
128
134
|
src/ TypeScript API (component, types, exports)
|
|
@@ -132,22 +138,18 @@ plugin/ Expo config plugins (SPM injection, Gradle setup)
|
|
|
132
138
|
example/ Test app
|
|
133
139
|
```
|
|
134
140
|
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
1. A [Mapbox account](https://account.mapbox.com/) with Navigation SDK access
|
|
138
|
-
2. A public access token (`pk.xxx`) and a secret/download token (`sk.xxx`)
|
|
139
|
-
3. For iOS: `~/.netrc` must contain Mapbox credentials for SPM package resolution:
|
|
141
|
+
### Local Development
|
|
140
142
|
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
143
|
+
```bash
|
|
144
|
+
git clone https://github.com/baeckerherz/expo-mapbox-navigation.git
|
|
145
|
+
cd expo-mapbox-navigation
|
|
146
|
+
yarn install
|
|
145
147
|
```
|
|
146
148
|
|
|
147
|
-
|
|
149
|
+
### Running the Example App
|
|
148
150
|
|
|
149
151
|
```bash
|
|
150
|
-
cd
|
|
152
|
+
cd example
|
|
151
153
|
yarn install
|
|
152
154
|
npx expo prebuild --clean
|
|
153
155
|
npx expo run:ios --device
|
|
@@ -155,19 +157,6 @@ npx expo run:ios --device
|
|
|
155
157
|
|
|
156
158
|
The example app navigates from your current location to Innsbruck Hauptbahnhof with German voice guidance.
|
|
157
159
|
|
|
158
|
-
## Publishing to npm
|
|
159
|
-
|
|
160
|
-
```bash
|
|
161
|
-
npm login
|
|
162
|
-
npm publish --access public
|
|
163
|
-
```
|
|
164
|
-
|
|
165
|
-
Consumers install with:
|
|
166
|
-
|
|
167
|
-
```bash
|
|
168
|
-
npx expo install @baeckerherz/expo-mapbox-navigation
|
|
169
|
-
```
|
|
170
|
-
|
|
171
160
|
## Key differences from existing wrappers
|
|
172
161
|
|
|
173
162
|
| | This module | @badatgil/expo-mapbox-navigation | @homee/react-native-mapbox-navigation |
|