You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+47-10Lines changed: 47 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,34 @@
1
-
# Google Maps Navigation
1
+
# Google Maps Navigation (Preview)
2
2
3
-
A Flutter plugin that provides a [Google Maps Navigation](https://developers.google.com/maps/documentation/navigation) widget.
3
+
## Description
4
+
5
+
This repository contains a Flutter plugin that provides a [Google Maps Navigation](https://developers.google.com/maps/documentation/navigation) widget.
6
+
7
+
8
+
## Requirements
4
9
5
10
|| Android | iOS |
6
11
| ----------- | ------- | --------- |
7
12
|**Support**| SDK 23+ | iOS 14.0+ |
8
13
9
-
## Usage
14
+
* A Flutter project
15
+
* A Google Cloud project with the [Navigation SDK enabled](https://developers.google.com/maps/documentation/navigation/android-sdk/set-up-project) and the [Maps SDK for iOS enabled](https://developers.google.com/maps/documentation/navigation/ios-sdk/config)
16
+
* An API key from the project above
17
+
* If targeting Android, [Google Play Services](https://developers.google.com/android/guides/overview) installed and enabled
18
+
*[Attributions and licensing text](https://developers.google.com/maps/documentation/navigation/android-sdk/set-up-project#include_the_required_attributions_in_your_app) added to your app
19
+
20
+
## Installation
10
21
11
-
To use this plugin, add `google_maps_navigation` as a [dependency in your pubspec.yaml file](https://flutter.dev/using-packages/).
22
+
1. This repository is currently private. You will need to add the package dependency using [Git with SSH](https://docs.flutter.dev/packages-and-plugins/using-packages#dependencies-on-unpublished-packages)in the app's `pubspec.yaml` file. See [Connecting to GitHub with SSH](https://docs.github.com/en/authentication/connecting-to-github-with-ssh) for instructions on how to provide SSH keys.
2. Follow the instructions below to add your API key to the approrpiate files in your Flutter project.
14
32
15
33
* Enable Google Maps SDK and Google Maps Navigation SDK for each platform.
16
34
* Go to [Google Developers Console](https://console.cloud.google.com/).
@@ -66,7 +84,7 @@ import GoogleNavigation
66
84
}
67
85
```
68
86
69
-
### Integration Overview
87
+
##Usage
70
88
71
89
You can now add a `GoogleMapsNavigationView` widget to your widget tree.
72
90
@@ -75,7 +93,7 @@ The view can be controlled with the `GoogleNavigationViewController` that is pas
75
93
The `GoogleMapsNavigationView` widget should be used within a widget with a bounded size. Using it
76
94
in an unbounded widget will cause the application to throw a Flutter exception.
77
95
78
-
### Sample Usage
96
+
### Add a navigation view
79
97
80
98
```dart
81
99
import 'package:flutter/material.dart';
@@ -144,10 +162,12 @@ class _NavigationSampleState extends State<NavigationSample> {
144
162
145
163
See the [example](./example) directory for a complete navigation sample app.
146
164
147
-
## Permissions
165
+
### Requesting and handling permissions
166
+
148
167
The Google Navigation SDK Flutter plugin offers functionalities that necessitate specific permissions from the mobile operating system. These include, but are not limited to, location services, background execution, and receiving background location updates.
149
168
150
-
It is important to note that the management of these permissions falls outside the scope of the Google Navigation and Driver SDKs. As a developer integrating these SDKs into your applications, you are responsible for requesting and obtaining the necessary permissions from the users of your app.
169
+
> [!NOTE]
170
+
> The management of these permissions falls outside the scope of the Google Navigation and Driver SDKs. As a developer integrating these SDKs into your applications, you are responsible for requesting and obtaining the necessary permissions from the users of your app.
151
171
152
172
You can see example of handling permissions in the [main.dart](./example/lib/main.dart) file of the example application:
See the [Contributing guide](https://github.com/googlemaps/flutter-navigation-sdk/blob/main/CONTRIBUTING.md).
202
+
203
+
## Terms of Service
204
+
205
+
This package uses Google Maps Platform services, and any use of Google Maps Platform is subject to the [Terms of Service](https://cloud.google.com/maps-platform/terms).
206
+
207
+
For clarity, this package, and each underlying component, is not a Google Maps Platform Core Service.
208
+
209
+
## Support
210
+
211
+
This package is offered via an open source license. It is not governed by the Google Maps Platform Support [Technical Support Services Guidelines](https://cloud.google.com/maps-platform/terms/tssg), the [SLA](https://cloud.google.com/maps-platform/terms/sla), or the [Deprecation Policy](https://cloud.google.com/maps-platform/terms) (however, any Google Maps Platform services used by the library remain subject to the Google Maps Platform Terms of Service).
212
+
213
+
This package adheres to [semantic versioning](https://semver.org/) to indicate when backwards-incompatible changes are introduced. Accordingly, while the library is in version 0.x, backwards-incompatible changes may be introduced at any time.
214
+
215
+
If you find a bug, or have a feature request, please [file an issue](https://github.com/googlemaps/flutter-navigation-sdk/issues) on GitHub. If you would like to get answers to technical questions from other Google Maps Platform developers, ask through one of our [developer community channels](https://developers.google.com/maps/developer-community). If you'd like to contribute, please check the [Contributing guide](https://github.com/googlemaps/flutter-navigation-sdk/blob/main/CONTRIBUTING.md).
0 commit comments