Skip to content

Commit 0ecc362

Browse files
wescpyjeff-bowman
andauthored
chore: update README to template (#658)
* update README to template * fix: update README to template * fix: more README fixes from template * fix: more README fixes from template * chore: more README fixes from template --------- Co-authored-by: Jeff Bowman <[email protected]>
1 parent 6e95eb7 commit 0ecc362

File tree

1 file changed

+44
-21
lines changed

1 file changed

+44
-21
lines changed

README.md

Lines changed: 44 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
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+
![Release](https://github.com/googlemaps/android-maps-compose/workflows/Release/badge.svg)
23
![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)
4+
[![Tests/Build](https://github.com/googlemaps/android-maps-compose/actions/workflows/test.yml/badge.svg)](https://github.com/googlemaps/android-maps-compose/actions/workflows/test.yml)
5+
6+
![Contributors](https://img.shields.io/github/contributors/googlemaps/android-maps-compose?color=green)
7+
[![License](https://img.shields.io/github/license/googlemaps/android-maps-compose?color=blue)][license]
8+
[![StackOverflow](https://img.shields.io/stackexchange/stackoverflow/t/google-maps?color=orange&label=google-maps&logo=stackoverflow)](https://stackoverflow.com/questions/tagged/google-maps)
9+
[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server]
510

611
# Maps Compose 🗺
712

@@ -11,10 +16,12 @@ This repository contains [Jetpack Compose][jetpack-compose] components for the [
1116

1217
## Requirements
1318

19+
* Android API level 21+
1420
* Kotlin-enabled project
1521
* Jetpack Compose-enabled project (see [releases](https://github.com/googlemaps/android-maps-compose/releases) for the required version of Jetpack Compose)
16-
* An [API key][api-key]
17-
* API level 21+
22+
* [Sign up with Google Maps Platform]
23+
* A Google Maps Platform [project] with the **Maps SDK for Android** enabled
24+
- An [API key] associated with the project above ... follow the [API key instructions] if you're new to the process
1825

1926
## Installation
2027

@@ -37,20 +44,18 @@ dependencies {
3744

3845
This repository includes a [sample app](app).
3946

40-
To run it:
47+
To run the demo app, ensure you've met the requirements above then:
4148

42-
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.
49+
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.
4450
If the `secrets.properties` file does not exist, create it in the same folder as the `local.default.properties` file.
45-
4651
```
4752
MAPS_API_KEY=YOUR_API_KEY
4853
```
49-
3. Build and run
54+
1. Build and run
5055

5156
## Documentation
5257

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

5560
## Usage
5661

@@ -474,24 +479,42 @@ The colors of the text, line, and shadow are also all configurable (e.g., based
474479

475480
## Contributing
476481

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

479490
## Support
480491

481-
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).
492+
This library 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 library remain subject to the Google Maps Platform Terms of Service.
482493

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

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

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].
498+
You can also discuss this library on our [Discord server].
488499

500+
[API key]: https://developers.google.com/maps/documentation/android-sdk/get-api-key
501+
[API key instructions]: https://developers.google.com/maps/documentation/android-sdk/config#step_3_add_your_api_key_to_the_project
489502
[maps-sdk]: https://developers.google.com/maps/documentation/android-sdk
490-
[api-key]: https://developers.google.com/maps/documentation/android-sdk/get-api-key
503+
[documentation]: https://googlemaps.github.io/android-maps-compose
504+
[jetpack-compose]: https://developer.android.com/jetpack/compose
505+
506+
[code of conduct]: ?tab=coc-ov-file#readme
507+
[contributing guide]: CONTRIBUTING.md
508+
[Deprecation Policy]: https://cloud.google.com/maps-platform/terms
509+
[developer community channels]: https://developers.google.com/maps/developer-community
491510
[Discord server]: https://discord.gg/hYsWbmk
492-
[Javadoc]: https://googlemaps.github.io/android-maps-compose
493-
[contributing]: CONTRIBUTING.md
494-
[code of conduct]: CODE_OF_CONDUCT.md
495511
[file an issue]: https://github.com/googlemaps/android-maps-compose/issues/new/choose
512+
[license]: LICENSE
513+
[project]: https://developers.google.com/maps/documentation/android-sdk/cloud-setup
496514
[pull request]: https://github.com/googlemaps/android-maps-compose/compare
497-
[jetpack-compose]: https://developer.android.com/jetpack/compose
515+
[semantic versioning]: https://semver.org
516+
[Sign up with Google Maps Platform]: https://console.cloud.google.com/google/maps-apis/start
517+
[similar inquiry]: https://github.com/googlemaps/android-maps-compose/issues
518+
[SLA]: https://cloud.google.com/maps-platform/terms/sla
519+
[Technical Support Services Guidelines]: https://cloud.google.com/maps-platform/terms/tssg
520+
[Terms of Service]: https://cloud.google.com/maps-platform/terms

0 commit comments

Comments
 (0)