Skip to content

Commit 5a9054f

Browse files
committed
fix: update README to template
1 parent d915323 commit 5a9054f

File tree

1 file changed

+38
-19
lines changed

1 file changed

+38
-19
lines changed

README.md

Lines changed: 38 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
1-
![Build Status](https://github.com/googlemaps/android-maps-utils/actions/workflows/test.yml/badge.svg?branch=main)
2-
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.google.maps.android/android-maps-utils/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.google.maps.android/android-maps-utils)
1+
[![Maven Central](https://img.shields.io/maven-central/v/com.google.maps.android/android-maps-utils)](https://maven-badges.herokuapp.com/maven-central/com.google.maps.android/android-maps-utils)
2+
![Tests/Build Status](https://github.com/googlemaps/android-maps-utils/workflows/Test/badge.svg)
3+
![Release](https://github.com/googlemaps/android-maps-utils/workflows/Release/badge.svg)
4+
![Stable](https://img.shields.io/badge/stability-stable-green)
5+
36
![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/android-maps-utils?color=green)
4-
[![Discord](https://img.shields.io/discord/676948200904589322)](https://discord.gg/hYsWbmk)
5-
![Apache-2.0](https://img.shields.io/badge/license-Apache-blue)
7+
[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server]
8+
[![GitHub License](https://img.shields.io/github/license/googlemaps/android-maps-utils?color=blue)](LICENSE)
69

710
# Maps SDK for Android Utility Library
811

912
## Description
1013

1114
This open-source library contains utilities that are useful for a wide
12-
range of applications using the [Google Maps SDK for Android][android-site].
15+
range of applications using the [Google Maps SDK for Android][maps-sdk].
1316

1417
- **Marker animation** - animates a marker from one position to another
1518
- **Marker clustering** — handles the display of a large number of points
@@ -30,7 +33,7 @@ You can also find Kotlin extensions for this library in [Maps Android KTX][andro
3033
## Requirements
3134

3235
* Android API level 21+
33-
- An [API key](https://developers.google.com/maps/documentation/android-sdk/get-api-key)
36+
- An [API key][api-key]
3437

3538
## Installation
3639

@@ -47,22 +50,23 @@ dependencies {
4750
}
4851
```
4952

50-
## Demo App
53+
## Sample App
5154

5255
<img src="https://developers.google.com/maps/documentation/android-sdk/images/utility-markercluster.png" width="150" align=right>
5356

5457
This repository includes a [sample app](demo) that illustrates the use of this library.
5558

5659
To run the demo app, you'll have to:
5760

58-
1. [Get a Maps API key](https://developers.google.com/maps/documentation/android-sdk/get-api-key)
61+
1. [Sign up for Google Maps Platform ][gmp-start]
62+
1. [Get a Maps API key][api-key]
5963
1. Add a file `local.properties` in the root project (this file should *NOT* be under version control to protect your API key)
6064
1. Add a single line to `local.properties` that looks like `MAPS_API_KEY=YOUR_API_KEY`, where `YOUR_API_KEY` is the API key you obtained in the first step
6165
1. Build and run the `debug` variant for the Maps SDK for Android version
6266

6367
## Documentation
6468

65-
See the [reference documentation][dokka] for a full list of classes and their methods.
69+
See the [documentation] for a full list of classes and their methods.
6670

6771
## Usage
6872

@@ -340,23 +344,38 @@ _Old_
340344

341345
## Contributing
342346

343-
Contributions are welcome and encouraged! See the [contributing guide](CONTRIBUTING.md) for more info.
347+
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].
348+
349+
## Terms of Service
350+
351+
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].
352+
353+
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.
344354

345355
## Support
346356

347357
This library is offered via an open source [license](LICENSE). It is not governed by the Google Maps Platform [Technical Support Services Guidelines](https://cloud.google.com/maps-platform/terms/tssg?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components), the [SLA](https://cloud.google.com/maps-platform/terms/sla?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components), or the [Deprecation Policy](https://cloud.google.com/maps-platform/terms?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components) (however, any Google Maps Platform services used by the library remain subject to the Google Maps Platform Terms of Service).
348358

349-
This library adheres to [semantic versioning](https://semver.org/) to indicate when backwards-incompatible changes are introduced.
359+
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.
350360

351-
If you find a bug, or have a feature request, please [file an issue] on GitHub.
361+
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].
352362

353-
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?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components) including the Google Maps Platform [Discord server].
363+
You can also discuss this library on our [Discord server].
354364

355-
[file an issue]: https://github.com/googlemaps/android-maps-utils/issues/new/choose
356-
[pull request]: https://github.com/googlemaps/android-maps-utils/compare
357-
[code of conduct]: CODE_OF_CONDUCT.md
358-
[Discord server]: https://discord.gg/hYsWbmk
359-
[android-site]: https://developers.google.com/maps/documentation/android-sdk
365+
[api-key]: https://developers.google.com/maps/documentation/android-sdk/get-api-key
360366
[devsite-guide]: https://developers.google.com/maps/documentation/android-sdk/utility
361-
[dokka]: https://googlemaps.github.io/android-maps-utils/
367+
[gmp-start]: https://console.cloud.google.com/google/maps-apis/start
368+
[maps-sdk]: https://developers.google.com/maps/documentation/android-sdk
369+
[documentation]: https://googlemaps.github.io/android-maps-utils
362370
[android-maps-ktx]: https://github.com/googlemaps/android-maps-ktx
371+
372+
[code of conduct]: CODE_OF_CONDUCT.md
373+
[contributing guide]: CONTRIBUTING.md
374+
[developer community channels]: https://developers.google.com/maps/developer-community
375+
[Discord server]: https://discord.gg/hYsWbmk
376+
[file an issue]: https://github.com/googlemaps/android-maps-utils/issues/new/choose
377+
[pull request]: https://github.com/googlemaps/android-maps-utils/compare
378+
[semantic versioning]: https://semver.org
379+
[similar inquiry]: https://github.com/googlemaps/android-maps-utils/issues
380+
[Terms of Service]: https://cloud.google.com/maps-platform/terms
381+

0 commit comments

Comments
 (0)