Skip to content

Commit 9d1089f

Browse files
authored
chore: update README per template (#1932)
* chore: update README per template * chore: more README fixes from template Skipping failed tests for this README update.
1 parent a87766a commit 9d1089f

File tree

1 file changed

+47
-41
lines changed

1 file changed

+47
-41
lines changed

README.md

Lines changed: 47 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
1-
![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/android-samples)
2-
![Apache-2.0](https://img.shields.io/badge/license-Apache-blue)
3-
[![Build demos](https://github.com/googlemaps/android-samples/workflows/Build%20demos/badge.svg)](https://github.com/googlemaps/android-samples/actions?query=workflow%3A%22Build+demos%22)
4-
[![Discord](https://img.shields.io/discord/676948200904589322)](https://discord.gg/hYsWbmk)
1+
[![Build](https://github.com/googlemaps-samples/android-samples/actions/workflows/build.yml/badge.svg)](https://github.com/googlemaps-samples/android-samples/actions/workflows/build.yml)
52

6-
Google Maps SDK for Android Samples
7-
===================================
3+
![Contributors](https://img.shields.io/github/contributors/googlemaps-samples/android-samples?color=green)
4+
[![License](https://img.shields.io/github/license/googlemaps-samples/android-samples?color=blue)][license]
5+
[![StackOverflow](https://img.shields.io/stackexchange/stackoverflow/t/google-maps?color=orange&label=google-maps&logo=stackoverflow)](https://stackoverflow.com/questions/tagged/android+google-maps)
6+
[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server]
7+
8+
# Google Maps SDK for Android Samples
89

910
<img src="images/screenshots.png" width="1024" />
1011

12+
## Description
13+
1114
Samples demonstrating how to use
1215
[Maps SDK for Android](https://developers.google.com/maps/documentation/android/).
1316

17+
## Samples in this repo (if more than one)
18+
1419
This repo contains the following samples:
1520

1621
1. [ApiDemos](ApiDemos): A collection of small demos showing most features of the Maps SDK for Android.
@@ -21,57 +26,58 @@ setup required for a gradle-based Android Studio project.
2126
associated with tutorials in the developer's guide. See each sample for a link to the associated guide.
2227
1. [Snippets](snippets): Snippets for code found in https://developers.google.com/maps/documentation/android-sdk
2328

29+
## Requirements
2430

25-
Pre-requisites
26-
--------------
31+
To run the samples, you will need:
2732

28-
* See each sample for pre-requisites.
29-
* All require up-to-date versions of the Android build tools and the Android support repository.
30-
* The demo apps require that you add your own Google Maps API key. See [Get an API key](https://developers.google.com/maps/documentation/android-sdk/get-api-key) docs for more instructions.
33+
- To [sign up with Google Maps Platform]
34+
- A Google Maps Platform [project] with the **Maps SDK for Android** enabled
35+
- An [API key] associated with the project above ... follow the [API key instructions] if you're new to the process
36+
- See each sample for pre-requisites.
37+
- All require up-to-date versions of the Android build tools and the Android support repository.
3138

32-
Getting Started
33-
---------------
39+
## Running the sample(s)
3440

3541
1. Download the samples by cloning this repository
36-
2. In the welcome screen of Android Studio, select "Open an Existing project"
37-
3. Select one of the sample directories from this repository
42+
1. In the welcome screen of Android Studio, select "Open an Existing project"
43+
1. Select one of the sample directories from this repository
3844

3945
Alternatively, use the `gradlew build` command to build the project directly or download an APK
4046
under [releases](https://github.com/googlemaps/android-samples/releases).
4147

42-
Support
43-
-------
48+
## Contributing
49+
50+
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].
4451

45-
- Stack Overflow: https://stackoverflow.com/questions/tagged/android+google-maps
52+
## Terms of Service
4653

47-
If you have discovered an issue with the Google Maps Platform SDK for Android v2, please see
48-
the resources here: https://developers.google.com/maps/support/
54+
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].
4955

50-
If you've found an error in these samples, please file an issue:
51-
https://github.com/googlemaps/android-samples/issues
56+
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.
5257

53-
Patches are encouraged, and may be submitted according to the instructions in
54-
CONTRIBUTING.md.
58+
## Support
5559

56-
License
57-
-------
58-
(See each sample directory for details.)
60+
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.
5961

60-
Copyright 2015 The Android Open Source Project
62+
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].
6163

62-
Copyright 2015 Google, Inc.
64+
You can also discuss this sample on our [Discord server].
6365

64-
Licensed to the Apache Software Foundation (ASF) under one or more contributor
65-
license agreements. See the NOTICE file distributed with this work for
66-
additional information regarding copyright ownership. The ASF licenses this
67-
file to you under the Apache License, Version 2.0 (the "License"); you may not
68-
use this file except in compliance with the License. You may obtain a copy of
69-
the License at
66+
[android-sdk]: https://developers.google.com/maps/documentation/android-sdk
67+
[API key]: https://developers.google.com/maps/documentation/android-sdk/get-api-key
68+
[API key instructions]: https://developers.google.com/maps/documentation/android-sdk/config#step_3_add_your_api_key_to_the_project
7069

71-
http://www.apache.org/licenses/LICENSE-2.0
70+
[code of conduct]: ?tab=coc-ov-file#readme
71+
[contributing guide]: CONTRIBUTING.md
72+
[Deprecation Policy]: https://cloud.google.com/maps-platform/terms
73+
[developer community channels]: https://developers.google.com/maps/developer-community
74+
[Discord server]: https://discord.gg/hYsWbmk
75+
[file an issue]: https://github.com/googlemaps-samples/android-samples/issues/new/choose
76+
[license]: LICENSE
77+
[pull request]: https://github.com/googlemaps-samples/android-samples/compare
78+
[project]: https://developers.google.com/maps/documentation/android-sdk/cloud-setup#enabling-apis
79+
[Sign up with Google Maps Platform]: https://console.cloud.google.com/google/maps-apis/start
80+
[SLA]: https://cloud.google.com/maps-platform/terms/sla
81+
[Technical Support Services Guidelines]: https://cloud.google.com/maps-platform/terms/tssg
82+
[Terms of Service]: https://cloud.google.com/maps-platform/terms
7283

73-
Unless required by applicable law or agreed to in writing, software
74-
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
75-
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
76-
License for the specific language governing permissions and limitations under
77-
the License.

0 commit comments

Comments
 (0)