Skip to content

Commit d1fb583

Browse files
committed
update README to template
1 parent 3ba3831 commit d1fb583

File tree

1 file changed

+33
-16
lines changed

1 file changed

+33
-16
lines changed

README.md

Lines changed: 33 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1-
![Tests](https://github.com/googlemaps/android-maps-compose/actions/workflows/test.yml/badge.svg)
1+
[![Maven Central](https://img.shields.io/maven-central/v/com.google.maps.android/maps-compose)](https://maven-badges.herokuapp.com/maven-central/com.google.maps.android/maps-compose)
2+
![Tests/Build Status](https://github.com/googlemaps/android-maps-compose/workflows/Test/badge.svg)
3+
![Release](https://github.com/googlemaps/android-maps-compose/workflows/Release/badge.svg)
24
![Stable](https://img.shields.io/badge/stability-stable-green)
3-
[![Discord](https://img.shields.io/discord/676948200904589322)][Discord server]
4-
![Apache-2.0](https://img.shields.io/badge/license-Apache-blue)
5+
6+
![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/android-maps-compose?color=green)
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-compose?color=blue)](LICENSE)
59

610
# Maps Compose 🗺
711

@@ -39,18 +43,18 @@ This repository includes a [sample app](app).
3943

4044
To run it:
4145

46+
1. [Sign up for Google Maps Platform ][gmp-start]
4247
1. Get a [Maps API key][api-key]
43-
2. Open the `secrets.properties` file in your top-level directory, and then add the following code. Replace YOUR_API_KEY with your API key. Store your key in this file because secrets.properties is excluded from being checked into a version control system.
48+
1. Open the `secrets.properties` file in your top-level directory, and then add the following code. Replace YOUR_API_KEY with your API key. Store your key in this file because secrets.properties is excluded from being checked into a version control system.
4449
If the `secrets.properties` file does not exist, create it in the same folder as the `local.default.properties` file.
45-
4650
```
4751
MAPS_API_KEY=YOUR_API_KEY
4852
```
49-
3. Build and run
53+
1. Build and run
5054

5155
## Documentation
5256

53-
You can learn more about all the extensions provided by this library by reading the [reference documents][Javadoc].
57+
See the [documentation] for a full list of classes and their methods.
5458

5559
## Usage
5660

@@ -474,24 +478,37 @@ The colors of the text, line, and shadow are also all configurable (e.g., based
474478

475479
## Contributing
476480

477-
Contributions are welcome and encouraged! See [contributing] for more info.
481+
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].
482+
483+
## Terms of Service
484+
485+
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].
486+
487+
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.
478488

479489
## Support
480490

481491
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=android_oss), the [SLA](https://cloud.google.com/maps-platform/terms/sla?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=android_oss), or the [Deprecation Policy](https://cloud.google.com/maps-platform/terms?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=android_oss) (however, any Google Maps Platform services used by the library remain subject to the Google Maps Platform Terms of Service).
482492

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

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

487-
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=android_oss) including the Google Maps Platform [Discord server].
497+
You can also discuss this library on our [Discord server].
488498

489-
[maps-sdk]: https://developers.google.com/maps/documentation/android-sdk
490499
[api-key]: https://developers.google.com/maps/documentation/android-sdk/get-api-key
491-
[Discord server]: https://discord.gg/hYsWbmk
492-
[Javadoc]: https://googlemaps.github.io/android-maps-compose
493-
[contributing]: CONTRIBUTING.md
500+
[devsite-guide]: https://developers.google.com/maps/documentation/android-sdk/utility
501+
[gmp-start]: https://console.cloud.google.com/google/maps-apis/start
502+
[maps-sdk]: https://developers.google.com/maps/documentation/android-sdk
503+
[documentation]: https://googlemaps.github.io/android-maps-compose
504+
[jetpack-compose]: https://developer.android.com/jetpack/compose
505+
494506
[code of conduct]: CODE_OF_CONDUCT.md
507+
[contributing guide]: CONTRIBUTING.md
508+
[developer community channels]: https://developers.google.com/maps/developer-community
509+
[Discord server]: https://discord.gg/hYsWbmk
495510
[file an issue]: https://github.com/googlemaps/android-maps-compose/issues/new/choose
496511
[pull request]: https://github.com/googlemaps/android-maps-compose/compare
497-
[jetpack-compose]: https://developer.android.com/jetpack/compose
512+
[semantic versioning]: https://semver.org
513+
[similar inquiry]: https://github.com/googlemaps/android-maps-compose/issues
514+
[Terms of Service]: https://cloud.google.com/maps-platform/terms

0 commit comments

Comments
 (0)