Skip to content

Commit 576ed14

Browse files
committed
chore: update README per template
1 parent 241caec commit 576ed14

File tree

1 file changed

+52
-5
lines changed

1 file changed

+52
-5
lines changed

README.md

+52-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,61 @@
1-
Using Maps SDK for iOS with SwiftUI
2-
===================================
1+
![Contributors](https://img.shields.io/github/contributors/googlemaps-samples/codelab-maps-platform-101-ios-swiftui?color=green)
2+
[![License](https://img.shields.io/github/license/googlemaps-samples/codelab-maps-platform-101-ios-swiftui?color=blue)][license]
3+
[![StackOverflow](https://img.shields.io/stackexchange/stackoverflow/t/google-maps?color=orange&label=google-maps&logo=stackoverflow)](https://stackoverflow.com/questions/tagged/google-maps)
4+
[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server]
5+
6+
# Using Maps SDK for iOS with SwiftUI codelab
37

48
![App screenhsot](screenshot.png)
59

610
## Description
7-
Accompanying starter and solution code for the [Add a map to your iOS app with SwiftUI (Swift)][codelab], a codelab that teaches you how to integrate the Maps SDK for iOS with SwiftUI.
11+
12+
This repository provides the accompanying starter and solution code for the [Add a map to your iOS app with SwiftUI (Swift)][codelab], a codelab that teaches you how to integrate the [Maps SDK for iOS][maps-sdk] with SwiftUI.
813

914
## Requirements
10-
* Xcode 11.0 or higher
11-
* [Carthage][carthage]
15+
16+
To run the samples, you will need:
17+
18+
- To [sign up with Google Maps Platform]
19+
- A Google Maps Platform [project] with the **Maps SDK for iOS** enabled
20+
- An [API key] associated with the project above ... follow the [API key instructions] if you're new to the process
21+
- Swift and Xcode 11+
22+
- (Deployment target of) iOS 11+
23+
- [Carthage][carthage]
24+
25+
## Contributing
26+
27+
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].
28+
29+
## Terms of Service
30+
31+
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].
32+
33+
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.
34+
35+
## Support
36+
37+
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.
38+
39+
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].
40+
41+
You can also discuss this sample on our [Discord server].
1242

1343
[carthage]: https://github.com/Carthage/Carthage
1444
[codelab]: https://developers.google.com/codelabs/maps-platform/maps-platform-ios-swiftui
45+
[maps-sdk]: https://developers.google.com/maps/documentation/ios-sdk
46+
[API key]: https://developers.google.com/maps/documentation/ios-sdk/get-api-key
47+
[API key instructions]: https://developers.google.com/maps/documentation/ios-sdk/config#get-key
48+
49+
[code of conduct]: ?tab=coc-ov-file#readme
50+
[contributing guide]: CONTRIBUTING.md
51+
[Deprecation Policy]: https://cloud.google.com/maps-platform/terms
52+
[developer community channels]: https://developers.google.com/maps/developer-community
53+
[Discord server]: https://discord.gg/hYsWbmk
54+
[file an issue]: https://github.com/googlemaps-samples/codelab-maps-platform-101-ios-swiftui/issues/new/choose
55+
[license]: LICENSE
56+
[pull request]: https://github.com/googlemaps-samples/codelab-maps-platform-101-ios-swiftui/compare
57+
[project]: https://developers.google.com/maps/documentation/ios-sdk/cloud-setup#enabling-apis
58+
[Sign up with Google Maps Platform]: https://console.cloud.google.com/google/maps-apis/start
59+
[SLA]: https://cloud.google.com/maps-platform/terms/sla
60+
[Technical Support Services Guidelines]: https://cloud.google.com/maps-platform/terms/tssg
61+
[Terms of Service]: https://cloud.google.com/maps-platform/terms

0 commit comments

Comments
 (0)