Skip to content

Commit 9b0f33c

Browse files
authored
docs: Update README.md (#1)
* docs: Update README.md * docs: clarify install instructions
1 parent d9b2c16 commit 9b0f33c

File tree

1 file changed

+47
-10
lines changed

1 file changed

+47
-10
lines changed

README.md

Lines changed: 47 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,34 @@
1-
# Google Maps Navigation
1+
# Google Maps Navigation (Preview)
22

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
49

510
| | Android | iOS |
611
| ----------- | ------- | --------- |
712
| **Support** | SDK 23+ | iOS 14.0+ |
813

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
1021

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.
1223

13-
## Getting Started
24+
```
25+
dependencies:
26+
packageA:
27+
git:
28+
url: [email protected]:googlemaps/flutter-navigation-sdk.git
29+
```
30+
31+
2. Follow the instructions below to add your API key to the approrpiate files in your Flutter project.
1432

1533
* Enable Google Maps SDK and Google Maps Navigation SDK for each platform.
1634
* Go to [Google Developers Console](https://console.cloud.google.com/).
@@ -66,7 +84,7 @@ import GoogleNavigation
6684
}
6785
```
6886

69-
### Integration Overview
87+
## Usage
7088

7189
You can now add a `GoogleMapsNavigationView` widget to your widget tree.
7290

@@ -75,7 +93,7 @@ The view can be controlled with the `GoogleNavigationViewController` that is pas
7593
The `GoogleMapsNavigationView` widget should be used within a widget with a bounded size. Using it
7694
in an unbounded widget will cause the application to throw a Flutter exception.
7795

78-
### Sample Usage
96+
### Add a navigation view
7997

8098
```dart
8199
import 'package:flutter/material.dart';
@@ -144,10 +162,12 @@ class _NavigationSampleState extends State<NavigationSample> {
144162

145163
See the [example](./example) directory for a complete navigation sample app.
146164

147-
## Permissions
165+
### Requesting and handling permissions
166+
148167
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.
149168

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.
151171
152172
You can see example of handling permissions in the [main.dart](./example/lib/main.dart) file of the example application:
153173

@@ -175,4 +195,21 @@ Widget build(BuildContext context) {
175195
_requestLocationPermission();
176196
...
177197
}
178-
```
198+
```
199+
## Contributing
200+
201+
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

Comments
 (0)