Skip to content

Commit eaf996a

Browse files
committed
fix: update README per template
1 parent bfb8c49 commit eaf996a

File tree

1 file changed

+41
-23
lines changed

1 file changed

+41
-23
lines changed

README.md

Lines changed: 41 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
1-
![Run unit tests](https://github.com/googlemaps/google-maps-ios-utils/workflows/Build%20and%20Test/badge.svg)
1+
![Release](https://github.com/googlemaps/google-maps-ios-utils/workflows/Release/badge.svg)
2+
![Stable](https://img.shields.io/badge/stability-stable-green)
3+
[![Tests/Build Status](https://github.com/googlemaps/google-maps-ios-utils/actions/workflows/test.yml/badge.svg)](https://github.com/googlemaps/google-maps-ios-utils/actions/workflows/test.yml)
24
[![pod](https://img.shields.io/cocoapods/v/Google-Maps-iOS-Utils.svg)](https://cocoapods.org/pods/Google-Maps-iOS-Utils)
3-
![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/google-maps-ios-utils)
4-
![Apache-2.0](https://img.shields.io/badge/license-Apache-blue)
55

6-
Google Maps SDK for iOS Utility Library
7-
=======================================
6+
![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/google-maps-ios-utils?color=green)
7+
[![GitHub License](https://img.shields.io/github/license/googlemaps/google-maps-ios-utils?color=blue)][license]
8+
[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server]
9+
10+
# Google Maps SDK for iOS Utility Library
811

912
## Description
1013

1114
This open-source library contains classes that are useful for a wide
12-
range of applications using the [Google Maps SDK for iOS][sdk].
15+
range of applications using the [Google Maps SDK for iOS][ios-sdk].
1316

1417
- **Geometry libraries** - [KML and GeoJSON rendering][geometry-rendering]
1518
- **Geometry utilities** - Handy spherical [geometry utility][geometry-utils] functions
@@ -23,10 +26,11 @@ range of applications using the [Google Maps SDK for iOS][sdk].
2326

2427
## Requirements
2528

26-
- iOS 15.0+
27-
- Xcode 15.0+
28-
- [Maps SDK for iOS][sdk] (see [Releases](https://github.com/googlemaps/google-maps-ios-utils/releases) for minimum compatible version)
29-
- A Google Maps Platform [API key](https://developers.google.com/maps/documentation/ios-sdk/get-api-key) from a project with the **Maps SDK for iOS** enabled.
29+
* [Sign up with Google Maps Platform]
30+
* A Google Maps Platform project with the [**Maps SDK for iOS**][ios-sdk] enabled
31+
* An [API key] associated with the project above
32+
* Swift and XCode 15+
33+
* (Deployment target of) iOS 15+
3034

3135
## Installation
3236

@@ -46,7 +50,7 @@ range of applications using the [Google Maps SDK for iOS][sdk].
4650
```
4751

4852
> [!IMPORTANT]
49-
> You also need to install the Maps SDK for iOS, which is also supported in Swift Package Manager at the URL `https://github.com/googlemaps/ios-maps-sdk`
53+
> You also need to install the Maps SDK for iOS, which is also supported in Swift Package Manager at the URL `https://github.com/googlemaps/google-maps-ios-utils`
5054
5155
3. Select the
5256
[version](https://github.com/googlemaps/google-maps-ios-utils/releases)
@@ -191,33 +195,47 @@ func renderKml() {
191195

192196
## Contributing
193197

194-
Contributions are welcome and encouraged. Please see the [contributing guide][contributing] for guidance.
198+
External contributions are not accepted for this repository. See [contributing guide] for more info.
195199

196200
## Terms of Service
197201

198-
This library uses Google Maps Platform services. Use of Google Maps Platform services through this library is subject to the Google Maps Platform [Terms of Service](https://cloud.google.com/maps-platform/terms).
202+
This library uses Google Maps Platform services. Use of Google Maps Platform services through this library is subject to the Google Maps Platform [Terms of Service].
199203

200204
This library is not a Google Maps Platform Core Service. Therefore, the Google Maps Platform Terms of Service (e.g. Technical Support Services, Service Level Agreements, and Deprecation Policy) do not apply to the code in this library.
201205

202206
## Support
203207

204-
This library 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).
208+
This library is offered via an open source [license]. It is not governed by the Google Maps Platform Support [Technical Support Services Guidelines, the SLA, or the [Deprecation Policy]. However, any Google Maps Platform services used by the library remain subject to the Google Maps Platform Terms of Service.
205209

206-
This library 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.
210+
This library adheres to [semantic versioning] 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.
207211

208-
If you find a bug, or have a feature request, please file an [issue] 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.
212+
If you find a bug, or have a feature request, please [file an issue] 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]. If you'd like to contribute, please check the [contributing guide].
209213

210214
You can also discuss this library on our [Discord server].
211215

212-
[Discord server]: https://discord.gg/hYsWbmk
213-
[Carthage doc]: docs/Carthage.md
214-
[contributing]: CONTRIBUTING.md
215-
[code of conduct]: CODE_OF_CONDUCT.md
216-
[devsite-guide]: https://developers.google.com/maps/documentation/ios-sdk/utility/
217216
[sdk]: https://developers.google.com/maps/documentation/ios-sdk
218-
[issue]: https://github.com/googlemaps/google-maps-ios-utils/issues
219-
[license]: LICENSE
220217
[customizing-markers]: docs/CustomMarkers.md
221218
[geometry-rendering]: docs/GeometryRendering.md
222219
[heatmap-rendering]: docs/HeatmapRendering.md
223220
[geometry-utils]: docs/GeometryUtils.md
221+
[Carthage doc]: docs/Carthage.md
222+
[devsite-guide]: https://developers.google.com/maps/documentation/ios-sdk/utility
223+
224+
[API key]: https://developers.google.com/maps/documentation/ios-sdk/get-api-key
225+
[documentation]: https://googlemaps.github.io/google-maps-ios-utils
226+
227+
[code of conduct]: CODE_OF_CONDUCT.md
228+
[contributing guide]: CONTRIBUTING.md
229+
[Deprecation Policy]: https://cloud.google.com/maps-platform/terms
230+
[developer community channels]: https://developers.google.com/maps/developer-community
231+
[Discord server]: https://discord.gg/hYsWbmk
232+
[file an issue]: https://github.com/googlemaps/google-maps-ios-utils/issues/new/choose
233+
[license]: LICENSE
234+
[pull request]: https://github.com/googlemaps/google-maps-ios-utils/compare
235+
[project]: https://developers.google.com/maps/documentation/navigation/ios-sdk/config
236+
[semantic versioning]: https://semver.org
237+
[Sign up with Google Maps Platform]: https://console.cloud.google.com/google/maps-apis/start
238+
[similar inquiry]: https://github.com/googlemaps/google-maps-ios-utils/issues
239+
[SLA]: https://cloud.google.com/maps-platform/terms/sla
240+
[Technical Support Services Guidelines]: https://cloud.google.com/maps-platform/terms/tssg
241+
[Terms of Service]: https://cloud.google.com/maps-platform/terms

0 commit comments

Comments
 (0)