From 9c9ce5eb845f124e75a848e02271833468e8fe9b Mon Sep 17 00:00:00 2001 From: wesley chun Date: Wed, 11 Dec 2024 20:27:35 -0800 Subject: [PATCH 1/2] fix: update README per template --- README.md | 73 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 53 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 3c8cea2..9775b72 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,29 @@ [![Run unit tests](https://github.com/googlemaps/ios-combine/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/googlemaps/ios-combine/actions/workflows/test.yml) [![pod](https://img.shields.io/cocoapods/v/GoogleMapsPlatformCombine)](https://cocoapods.org/pods/GoogleMapsPlatformCombine) -![Apache-2.0](https://img.shields.io/badge/license-Apache-blue) -GoogleMapsPlatformCombine -======================= +![Alpha release](https://img.shields.io/badge/release-alpha-orange) +![Release](https://github.com/googlemaps/ios-combine/workflows/Release/badge.svg) + +[![Tests/Build Status](https://github.com/googlemaps/ios-combine/actions/workflows/test.yml/badge.svg)](https://github.com/googlemaps/ios-combine/actions/workflows/test.yml) + +![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/ios-combine?color=green) +[![GitHub License](https://img.shields.io/github/license/googlemaps/ios-combine?color=blue)][license] +[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server] + +# Google Maps Platform Combine iOS Library (Alpha) ## Description -A Swift ilbrary containing Combine support, via `Publisher` and `Future`, for Google Maps Platform iOS SDKs. +A Swift library containing Combine support, via `Publisher` and `Future`, for Google Maps Platform iOS SDKs. -## Example +## Requirements -### Example Usage +* [Sign up with Google Maps Platform] +* A Google Maps Platform [project] with the **Maps SDK for iOS** enabled +* An [API key] associated with the project above +* Swift and XCode +* (Deployment target of) iOS 13+ + +## Usage ```swift // Create a GMSMapViewPublisher @@ -22,16 +35,13 @@ publisher.didChangeCameraPosition.sink { cameraPosition in } ``` -### Example Project +### Sample App To run the example project: 1. Run `pod install` from the Example/ directory. 2. Open the `GoogleMapsPlatformCombine.xcworkspace` file in Xcode -## Requirements -* Deployment Target of iOS 13.0+ - ## Installation ### [CocoaPods](https://cocoapods.org) @@ -59,22 +69,45 @@ this library via SPM you will need to also install Maps/Places using one of the supported package managers. See installation options for [Maps][maps-install] and [Places][places-install] for more information. +## Contributing + +Contributions are welcome and encouraged! If you'd like to contribute, send us a [pull request] and refer to our [code of conduct] and [contributing guide]. + +## Terms of Service + +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]. + +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. + ## Support -Encounter an issue while using this library? +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. -If you find a bug or have a feature request, please file an [issue]. -Or, if you'd like to contribute, please refer to our [contributing guide][contributing] and our [code of conduct]. +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. -You can also reach us on our [Discord channel]. +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]. -For more information, check out the detailed guide on the -[Google Developers site][devsite-guide]. +You can also discuss this library on our [Discord server]. [maps-install]: https://developers.google.com/maps/documentation/ios-sdk/start#download-sdk [places-install]: https://developers.google.com/maps/documentation/places/ios-sdk/start#step-2:-install-the-sdk -[contributing]: CONTRIBUTING.md + +[API key]: https://developers.google.com/maps/documentation/ios-sdk/get-api-key +[maps-sdk]: https://developers.google.com/maps/documentation/ios-sdk/overview +[documentation]: https://googlemaps.github.io/ios-combine + [code of conduct]: CODE_OF_CONDUCT.md -[Discord channel]: https://discord.gg/9fwRNWg -[issue]: https://github.com/googlemaps/ios-combine/issues -[devsite-guide]: https://developers.google.com/maps/documentation/ios-sdk/overview +[contributing guide]: CONTRIBUTING.md +[Deprecation Policy]: https://cloud.google.com/maps-platform/terms +[developer community channels]: https://developers.google.com/maps/developer-community +[Discord server]: https://discord.gg/hYsWbmk +[file an issue]: https://github.com/googlemaps/ios-combine/issues/new/choose +[license]: LICENSE +[pull request]: https://github.com/googlemaps/ios-combine/compare +[project]: https://developers.google.com/maps/documentation/ios-sdk/cloud-setup#enabling-apis +[semantic versioning]: https://semver.org +[Sign up with Google Maps Platform]: https://console.cloud.google.com/google/maps-apis/start +[similar inquiry]: https://github.com/googlemaps/ios-combine/issues +[SLA]: https://cloud.google.com/maps-platform/terms/sla +[Technical Support Services Guidelines]: https://cloud.google.com/maps-platform/terms/tssg +[Terms of Service]: https://cloud.google.com/maps-platform/terms From cc3fdb6a43c7eb8ab831c00e62d13e9dc1d2b2dc Mon Sep 17 00:00:00 2001 From: wesley chun Date: Sat, 8 Mar 2025 14:03:24 -0800 Subject: [PATCH 2/2] fix: README links --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9775b72..b52403c 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ publisher.didChangeCameraPosition.sink { cameraPosition in To run the example project: -1. Run `pod install` from the Example/ directory. +1. Run `pod install` from the Example/ directory. 2. Open the `GoogleMapsPlatformCombine.xcworkspace` file in Xcode ## Installation @@ -77,11 +77,11 @@ Contributions are welcome and encouraged! If you'd like to contribute, send us a 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]. -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. +This library is not a Google Maps Platform Core Service. Therefore, the Google Maps Platform Terms of Service, e.g., [Technical Support Services Guidelines], Service Level Agreement ["SLA"][SLA], and [Deprecation Policy], do not apply to the code in this library. ## Support -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. +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. 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. @@ -96,7 +96,7 @@ You can also discuss this library on our [Discord server]. [maps-sdk]: https://developers.google.com/maps/documentation/ios-sdk/overview [documentation]: https://googlemaps.github.io/ios-combine -[code of conduct]: CODE_OF_CONDUCT.md +[code of conduct]: ?tab=coc-ov-file#readme [contributing guide]: CONTRIBUTING.md [Deprecation Policy]: https://cloud.google.com/maps-platform/terms [developer community channels]: https://developers.google.com/maps/developer-community