Skip to content

Commit 9e4f7db

Browse files
Update SDK-specific READMEs
1 parent 6280461 commit 9e4f7db

File tree

4 files changed

+48
-24
lines changed

4 files changed

+48
-24
lines changed
Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,29 @@
1-
# google\_maps\_flutter\_ios
1+
# google\_maps\_flutter\_ios\_sdk10
22

3-
The iOS implementation of [`google_maps_flutter`][1].
3+
An iOS implementation of [`google_maps_flutter`][1] using
4+
[Google Maps SDK 10.x][2].
45

56
## Usage
67

7-
This package is [endorsed][2], which means you can simply use
8-
`google_maps_flutter` normally. This package will be automatically included in
9-
your app when you do, so you do not need to add it to your `pubspec.yaml`.
8+
This package is not the default [endorsed][3] version, so to select this SDK
9+
version for your implementation you must add a dependency on this package in
10+
your application's pubspec.yaml. Once you do, it will automatically replace the
11+
default implementation, then you can use `google_maps_flutter` as normal.
1012

11-
However, if you `import` this package to use any of its APIs directly, you
12-
should add it to your `pubspec.yaml` as usual.
13+
### Package Dependencies
14+
15+
If you are authoring a package, please *do not* depend on one of these specific
16+
implementation packages unless you have a compelling reason to do so. Instead,
17+
just depend on `google_maps_flutter`, so that application developers can
18+
select the appropriate SDK version for their minimum iOS version target.
19+
20+
## Minimum iOS Version
21+
22+
Google Maps SDK 10.x requires iOS 16, so if your application does not already
23+
require iOS 16 you must update your minimum iOS deployment version.
24+
25+
Alternatively, you could use a [different SDK version][4]
26+
with a lower iOS version requirement.
1327

1428
## Supported Heatmap Options
1529

@@ -22,4 +36,6 @@ should add it to your `pubspec.yaml` as usual.
2236
| HeatmapGradient.colorMapSize ||
2337

2438
[1]: https://pub.dev/packages/google_maps_flutter
25-
[2]: https://flutter.dev/to/endorsed-federated-plugin
39+
[2]: https://developers.google.com/maps/documentation/ios-sdk/release-notes
40+
[3]: https://flutter.dev/to/endorsed-federated-plugin
41+
[4]: https://pub.dev/packages?q=implements-federated-plugin%3Agoogle_maps_flutter+platform%3Aios

packages/google_maps_flutter/google_maps_flutter_ios_sdk10/example/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,3 @@ package.
77

88
Unless you are making changes to this implementation package, this example is
99
very unlikely to be relevant.
10-
11-
## Versions
12-
13-
This example requires iOS 14, so will select a 8.x GoogleMaps SDK version.
Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,29 @@
1-
# google\_maps\_flutter\_ios
1+
# google\_maps\_flutter\_ios\_sdk10
22

3-
The iOS implementation of [`google_maps_flutter`][1].
3+
An iOS implementation of [`google_maps_flutter`][1] using
4+
[Google Maps SDK 9.x][2].
45

56
## Usage
67

7-
This package is [endorsed][2], which means you can simply use
8-
`google_maps_flutter` normally. This package will be automatically included in
9-
your app when you do, so you do not need to add it to your `pubspec.yaml`.
8+
This package is not the default [endorsed][3] version, so to select this SDK
9+
version for your implementation you must add a dependency on this package in
10+
your application's pubspec.yaml. Once you do, it will automatically replace the
11+
default implementation, then you can use `google_maps_flutter` as normal.
1012

11-
However, if you `import` this package to use any of its APIs directly, you
12-
should add it to your `pubspec.yaml` as usual.
13+
### Package Dependencies
14+
15+
If you are authoring a package, please *do not* depend on one of these specific
16+
implementation packages unless you have a compelling reason to do so. Instead,
17+
just depend on `google_maps_flutter`, so that application developers can
18+
select the appropriate SDK version for their minimum iOS version target.
19+
20+
## Minimum iOS Version
21+
22+
Google Maps SDK 9.x requires iOS 15, so if your application does not already
23+
require iOS 15 you must update your minimum iOS deployment version.
24+
25+
Alternatively, you could use [`google_maps_flutter_ios`][4] to support
26+
iOS 14.
1327

1428
## Supported Heatmap Options
1529

@@ -22,4 +36,6 @@ should add it to your `pubspec.yaml` as usual.
2236
| HeatmapGradient.colorMapSize ||
2337

2438
[1]: https://pub.dev/packages/google_maps_flutter
25-
[2]: https://flutter.dev/to/endorsed-federated-plugin
39+
[2]: https://developers.google.com/maps/documentation/ios-sdk/release-notes
40+
[3]: https://flutter.dev/to/endorsed-federated-plugin
41+
[4]: https://pub.dev/packages/google_maps_flutter_ios

packages/google_maps_flutter/google_maps_flutter_ios_sdk9/example/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,3 @@ package.
77

88
Unless you are making changes to this implementation package, this example is
99
very unlikely to be relevant.
10-
11-
## Versions
12-
13-
This example requires iOS 14, so will select a 8.x GoogleMaps SDK version.

0 commit comments

Comments
 (0)