chore: update README per template (#228)

* chore: update README per template
* add CoC

Author: wescpy

CODE_OF_CONDUCT.md

@@ -0,0 +1,63 @@
+# Google Open Source Community Guidelines
+
+At Google, we recognize and celebrate the creativity and collaboration of open
+source contributors and the diversity of skills, experiences, cultures, and
+opinions they bring to the projects and communities they participate in.
+
+Every one of Google's open source projects and communities are inclusive
+environments, based on treating all individuals respectfully, regardless of
+gender identity and expression, sexual orientation, disabilities,
+neurodiversity, physical appearance, body size, ethnicity, nationality, race,
+age, religion, or similar personal characteristic.
+
+We value diverse opinions, but we value respectful behavior more.
+
+Respectful behavior includes:
+
+* Being considerate, kind, constructive, and helpful.
+* Not engaging in demeaning, discriminatory, harassing, hateful, sexualized, or
+  physically threatening behavior, speech, and imagery.
+* Not engaging in unwanted physical contact.
+
+Some Google open source projects [may adopt][] an explicit project code of
+conduct, which may have additional detailed expectations for participants. Most
+of those projects will use our [modified Contributor Covenant][].
+
+[may adopt]: https://opensource.google/docs/releasing/preparing/#conduct
+[modified Contributor Covenant]: https://opensource.google/docs/releasing/template/CODE_OF_CONDUCT/
+
+## Resolve peacefully
+
+We do not believe that all conflict is necessarily bad; healthy debate and
+disagreement often yields positive results. However, it is never okay to be
+disrespectful.
+
+If you see someone behaving disrespectfully, you are encouraged to address the
+behavior directly with those involved. Many issues can be resolved quickly and
+easily, and this gives people more control over the outcome of their dispute.
+If you are unable to resolve the matter for any reason, or if the behavior is
+threatening or harassing, report it. We are dedicated to providing an
+environment where participants feel welcome and safe.
+
+## Reporting problems
+
+Some Google open source projects may adopt a project-specific code of conduct.
+In those cases, a Google employee will be identified as the Project Steward,
+who will receive and handle reports of code of conduct violations. In the event
+that a project hasn’t identified a Project Steward, you can report problems by
+emailing [email protected].
+
+We will investigate every complaint, but you may not receive a direct response.
+We will use our discretion in determining when and how to follow up on reported
+incidents, which may range from not taking action to permanent expulsion from
+the project and project-sponsored spaces. We will notify the accused of the
+report and provide them an opportunity to discuss it before any action is
+taken. The identity of the reporter will be omitted from the details of the
+report supplied to the accused. In potentially harmful situations, such as
+ongoing harassment or threats to anyone's safety, we may take action without
+notice.
+
+*This document was adapted from the [IndieWeb Code of Conduct][] and can also
+be found at <https://opensource.google/conduct/>.*
+
+[IndieWeb Code of Conduct]: https://indieweb.org/code-of-conduct

README.md

@@ -1,9 +1,34 @@
-![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/maps-sdk-for-ios-samples)
-![Apache-2.0](https://img.shields.io/badge/license-Apache-blue)
+[![Build](https://github.com/googlemaps-samples/maps-sdk-for-ios-samples/actions/workflows/build.yml/badge.svg)](https://github.com/googlemaps-samples/maps-sdk-for-ios-samples/actions/workflows/build.yml)
+
+![Contributors](https://img.shields.io/github/contributors/googlemaps-samples/maps-sdk-for-ios-samples?color=green)
+[![License](https://img.shields.io/github/license/googlemaps-samples/maps-sdk-for-ios-samples?color=blue)][license]
+[![StackOverflow](https://img.shields.io/stackexchange/stackoverflow/t/google-maps?color=orange&label=google-maps&logo=stackoverflow)](https://stackoverflow.com/questions/tagged/google-maps)
+[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server]
 
 # Google Maps SDK for iOS, Google Places SDK for iOS, and Google Navigation SDK for iOS sample code
 
-This repository contains sample code for use with the Google Maps SDK for iOS, Google Places SDK for iOS and Google Navigation SDK for iOS.
+## Description
+
+This repository provides one or more samples demonstrating use of various **iOS SDKs** in the Google Maps Platform.
+
+## Samples in this repo
+
+This repository contains sample code for use with the
+
+- [Google Maps SDK for iOS][ios-sdk]
+- [Google Places SDK for iOS](https://developers.google.com/maps/documentation/places/ios-sdk), and
+- [Google Navigation SDK for iOS](https://developers.google.com/maps/documentation/navigation/ios-sdk)
+
+## Requirements
+
+To run the samples, you will need:
+
+- To [sign up with Google Maps Platform]
+- A Google Maps Platform [project] with the relevant SDK enabled
+- An [API key] associated with the project above ... follow the [API key instructions] if you're new to the process
+- Swift or Objective-C
+- Xcode 15+
+- (Deployment target of) iOS 15+
 
 ## GoogleMaps
 
@@ -26,9 +51,7 @@ $ pod install
 $ open GoogleMapsSwiftDemos.xcworkspace
 ```
 
-You will need to add an API Key to `GoogleMapsDemos/SDKDemoAPIKey.h`. Please see the
-[documentation](https://developers.google.com/maps/documentation/ios-sdk/start#get-key)
-for details on how to get an API Key.
+Add your API Key to `GoogleMapsDemos/SDKDemoAPIKey.h`.
 
 ## GoogleMaps-SwiftUI
 
@@ -39,8 +62,6 @@ $ cd GoogleMaps-SwiftUI
 $ open GoogleMaps-SwiftUI.xcodeproj
 ```
 
-You will need to add an API Key to your configuration. Please see the [documentation](https://developers.google.com/maps/documentation/ios-sdk/start#get-key) for details on how to get an API Key.
-
 This project uses Swift Package Manager and requires the [GoogleMaps package](https://github.com/googlemaps/ios-maps-sdk). The sample code demonstrates best practices for integrating Google Maps into SwiftUI-based iOS applications.
 
 ## GooglePlaces
@@ -62,9 +83,7 @@ $ pod install
 $ open GooglePlacesSwiftDemos.xcworkspace
 ```
 
-You will need to add an API Key to `GooglePlacesDemos/SDKDemoAPIKey.h`. Please see the
-[documentation](https://developers.google.com/places/ios-api/start#get-key)
-for details on how to get an API Key.
+Add your API Key to `GooglePlacesDemos/SDKDemoAPIKey.h`.
 
 ## GoogleNavigation
 
@@ -85,21 +104,18 @@ $ pod install
 $ open GoogleNavigationSwiftDemos.xcworkspace
 ```
 
-You will need to add an API Key to `GoogleNavigationDemos/SDKDemoAPIKey.h`. Please see the
-[documentation](https://developers.google.com/maps/documentation/navigation/ios-sdk/get-api-key)
-for details on how to get an API Key.
+Add your API Key to `GoogleNavigationDemos/SDKDemoAPIKey.h`.
 
 ## MapsAndPlacesDemo
-### Description
+
 This demo application looks to bridge some of the features found in the GooglePlaces and GoogleMaps demo applications as well as utilize some of the ways the two API's can work together.
 Click this [link](https://www.youtube.com/watch?v=u4Ih8EWqZio) to watch a video demonstration.
 
-__This project was made by Haiming Xu as an internship project from 05/2020 to 08/2020__
-### Requirements
 - If you are emulating this from you Mac, please make sure to set the emulated phone's location (otherwise, location features will not work)
 - A [Google Cloud Platform API key](https://developers.google.com/maps/documentation/ios-sdk/start#get-key) with Maps SDK for iOS and Places SDK for iOS enabled
 - A light and dark themed map, which can be created [here](https://console.cloud.google.com/google/maps-apis/client-styles?project=verdant-medium-278819&folder=&organizationId=) (make sure you sign in first)
 - If you want a different data set, ensure that it follows the correct formatting (and is also a JSON file) like the one provided (the data set provided can be found in dataset.json)
+
 ### Installation
 1. Make sure you are in the right folder (MapsAndPlacesDemo)
 2. Run `pod install`
@@ -109,23 +125,52 @@ __This project was made by Haiming Xu as an internship project from 05/2020 to 0
 ## Tutorials
 
 The `tutorials` sub-directory contains sample code that accompanies tutorials in the developer
-documentation, such as 
+documentation, such as
 [Adding a Map with a Marker](https://developers.google.com/maps/documentation/ios-sdk/map-with-marker),
 and more. Follow the tutorials for a quick guide to using the SDK.
 
 ## Snippets
 
 The `snippets` sub-directory contains code snippets that can be found in the developer documentation site.
 
+## Contributing
+
+External contributions are not accepted for this repository. See [contributing guide] for more info.
+
+## Terms of Service
+
+This sample uses Google Maps Platform services. Use of Google Maps Platform services through this sample is subject to the Google Maps Platform [Terms of Service].
+
+This sample 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 sample.
+
 ## Support
 
-If you find a bug or have a feature request related to these samples, please [file an issue](https://github.com/googlemaps/maps-sdk-for-ios-samples/issues).
+This sample 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 sample remain subject to the Google Maps Platform Terms of Service.
+
+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].
+
+If you find a bug or have a feature request related to one of the SDKs, you can file an issue at their respective pages:
+
+- [Maps SDK for iOS Issue Tracker](https://developers.google.com/maps/documentation/ios-sdk/support#issue-tracker)
+- [Places SDK for iOS Issue Tracker](https://developers.google.com/maps/documentation/places/ios-sdk/support#issue-tracker)
+- [Navigation SDK for iOS Issue Tracker](https://developers.google.com/maps/documentation/navigation/ios-sdk/support#issue-tracker)
 
-If you find a bug or have a feature request related to one of the SDKs, you can file an issue on either the
-[Google Maps SDK for iOS Issue Tracker](https://developers.google.com/maps/documentation/ios-sdk/support#issue-tracker).or the
-[Places SDK for iOS Issue Tracker](https://issuetracker.google.com/savedsearches/5050150).
+You can also discuss these samples on our [Discord server].
 
-You can also discover additional support services for the Google Maps Platform, including developer communities,
-technical guidance, and expert support at the Google Maps Platform [support resources page](https://developers.google.com/maps/support/).
+[ios-sdk]: https://developers.google.com/maps/documentation/ios-sdk
+[API key]: https://developers.google.com/maps/documentation/ios-sdk/get-api-key
+[API key instructions]: https://developers.google.com/maps/documentation/ios-sdk/config#get-key
 
-Thanks!
+[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
+[Discord server]: https://discord.gg/hYsWbmk
+[file an issue]: https://github.com/googlemaps-samples/maps-sdk-for-ios-samples/issues/new/choose
+[license]: LICENSE
+[pull request]: https://github.com/googlemaps-samples/maps-sdk-for-ios-samples/compare
+[project]: https://developers.google.com/maps/documentation/ios-sdk/cloud-setup#enabling-apis
+[Sign up with Google Maps Platform]: https://console.cloud.google.com/google/maps-apis/start
+[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