@baeckerherz/expo-mapbox-navigation 0.1.0 → 0.1.2

package/README.md

@@ -51,13 +51,31 @@ import { MapboxNavigation } from '@baeckerherz/expo-mapbox-navigation';
 
 ### Props
 
+#### Route
+
 | Prop | Type | Description |
 |------|------|-------------|
 | `coordinates` | `Array<{ latitude, longitude }>` | Route waypoints (min 2). First = origin, last = destination. |
-| `waypointIndices` | `number[]` | Which coordinates are full waypoints vs. via-points. |
-| `locale` | `string` | Language for voice guidance and UI. Default: device locale. |
-| `routeProfile` | `string` | Routing profile. Default: `"mapbox/driving-traffic"`. |
-| `mute` | `boolean` | Mute voice guidance. |
+| `waypointIndices` | `number[]` | Indices into `coordinates` treated as full waypoints (with arrival notification). Others are silent via-points. Must include first and last index. |
+| `routeProfile` | `string` | Mapbox routing profile. iOS: `"mapbox/driving-traffic"` (default), `"mapbox/driving"`, `"mapbox/walking"`, `"mapbox/cycling"`. Android: omit the `"mapbox/"` prefix. |
+
+#### Localization
+
+| Prop | Type | Description |
+|------|------|-------------|
+| `locale` | `string` | BCP 47 language tag for voice guidance, maneuver instructions, and UI labels (e.g. `"de"`, `"en-US"`). Default: device locale. |
+| `mute` | `boolean` | Mute voice guidance. Default: `false`. |
+
+#### Appearance
+
+| Prop | Type | Description |
+|------|------|-------------|
+| `mapStyle` | `string` | Custom Mapbox map style URL. Overrides the default navigation style. Example: `"mapbox://styles/mapbox/navigation-night-v1"`. |
+| `themeMode` | `"day" \| "night" \| "auto"` | Controls day/night map appearance. `"day"` (default): light map. `"night"`: dark 3D map. `"auto"`: switches based on time of day. |
+| `accentColor` | `string` | Primary accent color (hex). Applied to route line, floating buttons, and interactive elements. Example: `"#007AFF"`. |
+| `routeColor` | `string` | Route line color (hex). Overrides `accentColor` for the route line only. Example: `"#4264fb"`. |
+| `bannerBackgroundColor` | `string` | Instruction banner background color (hex). Example: `"#FFFFFF"` for light, `"#1A1A2E"` for dark. |
+| `bannerTextColor` | `string` | Instruction banner text color (hex). Example: `"#000000"`. |
 
 ### Events
 
@@ -71,7 +89,19 @@ import { MapboxNavigation } from '@baeckerherz/expo-mapbox-navigation';
 | `onUserOffRoute` | — | User went off the planned route. |
 | `onError` | `{ message }` | Navigation error occurred. |
 
-## Installation (for consumers)
+## Prerequisites
+
+1. A [Mapbox account](https://account.mapbox.com/) with Navigation SDK access
+2. A public access token (`pk.xxx`) and a secret/download token (`sk.xxx`)
+3. For iOS: `~/.netrc` must contain Mapbox credentials for SPM package resolution:
+
+```
+machine api.mapbox.com
+  login mapbox
+  password sk.eyJ1...YOUR_SECRET_TOKEN
+```
+
+## Installation
 
 ```bash
 npx expo install @baeckerherz/expo-mapbox-navigation
@@ -96,15 +126,9 @@ npx expo prebuild --clean
 npx expo run:ios
 ```
 
-## Development
-
-```bash
-cd @baeckerherz/expo-mapbox-navigation
-yarn install
-cd example && npx expo run:ios
-```
+## Contributing
 
-## Project Structure
+### Project Structure
 
 ```
 src/            TypeScript API (component, types, exports)
@@ -114,22 +138,18 @@ plugin/         Expo config plugins (SPM injection, Gradle setup)
 example/        Test app
 ```
 
-## Prerequisites
-
-1. A [Mapbox account](https://account.mapbox.com/) with Navigation SDK access
-2. A public access token (`pk.xxx`) and a secret/download token (`sk.xxx`)
-3. For iOS: `~/.netrc` must contain Mapbox credentials for SPM package resolution:
+### Local Development
 
-```
-machine api.mapbox.com
-  login mapbox
-  password sk.eyJ1...YOUR_SECRET_TOKEN
+```bash
+git clone https://github.com/baeckerherz/expo-mapbox-navigation.git
+cd expo-mapbox-navigation
+yarn install
 ```
 
-## How to test the example app
+### Running the Example App
 
 ```bash
-cd @baeckerherz/expo-mapbox-navigation/example
+cd example
 yarn install
 npx expo prebuild --clean
 npx expo run:ios --device
@@ -137,19 +157,6 @@ npx expo run:ios --device
 
 The example app navigates from your current location to Innsbruck Hauptbahnhof with German voice guidance.
 
-## Publishing to npm
-
-```bash
-npm login
-npm publish --access public
-```
-
-Consumers install with:
-
-```bash
-npx expo install @baeckerherz/expo-mapbox-navigation
-```
-
 ## Key differences from existing wrappers
 
 | | This module | @badatgil/expo-mapbox-navigation | @homee/react-native-mapbox-navigation |
@@ -171,6 +178,43 @@ npx expo install @baeckerherz/expo-mapbox-navigation
 
 ### Known risks
 
-- **SPM + CocoaPods coexistence**: Xcode may have trouble resolving both dependency managers. If this fails, fallback is to vendor `.xcframework` files (Approach A from the plan).
 - **Android NavigationView completeness**: The drop-in `NavigationView` in Android Nav SDK v3 may require additional configuration for full feature parity with iOS.
 - **Mapbox licensing**: The Navigation SDK requires a commercial Mapbox license for production use. This wrapper does not change that requirement.
+
+---
+
+## Contributors
+
+We're looking for **contributors and maintainers** to help shape this project. If you're interested in working on Expo native modules, Mapbox SDKs, or React Native tooling — we'd love to have you on board.
+
+Check out the [issues](https://github.com/baeckerherz/expo-mapbox-navigation/issues) or open a PR to get started.
+
+---
+
+## Sponsors
+
+This project is sponsored and maintained by the teams that use it in production.
+
+<table>
+  <tr>
+    <td align="center">
+      <a href="https://github.com/baeckerherz">
+        <img src="https://avatars.githubusercontent.com/u/261656164?s=200&v=4" width="100" alt="Bäckerherz" />
+        <br />
+        <strong>Bäckerherz</strong>
+      </a>
+      <br />
+      <em>Founding Sponsor</em>
+    </td>
+  </tr>
+</table>
+
+Bäckerherz builds and uses this module in their own apps. This project exists because of their investment in open-source tooling for the Expo ecosystem.
+
+**Become a sponsor** — help us keep this project maintained and growing. Reach out at [partner@baeckerherz.at](mailto:partner@baeckerherz.at).
+
+---
+
+## Need help building something?
+
+We build mobile apps, backend systems, and custom integrations using Expo, React Native, and more. If you need a team that ships — get in touch at [partner@baeckerherz.at](mailto:partner@baeckerherz.at).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baeckerherz/expo-mapbox-navigation",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Expo module wrapping Mapbox Navigation SDK v3 for iOS and Android",
   "main": "src/index.ts",
   "types": "src/index.ts",