From d1fb583dbb8c37b748e6859a718f206b3dbf319a Mon Sep 17 00:00:00 2001 From: wesley chun Date: Fri, 6 Dec 2024 01:46:57 -0800 Subject: [PATCH 1/5] update README to template --- README.md | 49 +++++++++++++++++++++++++++++++++---------------- 1 file changed, 33 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 6b636929..0ca28868 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ -![Tests](https://github.com/googlemaps/android-maps-compose/actions/workflows/test.yml/badge.svg) +[![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) +![Tests/Build Status](https://github.com/googlemaps/android-maps-compose/workflows/Test/badge.svg) +![Release](https://github.com/googlemaps/android-maps-compose/workflows/Release/badge.svg) ![Stable](https://img.shields.io/badge/stability-stable-green) -[![Discord](https://img.shields.io/discord/676948200904589322)][Discord server] -![Apache-2.0](https://img.shields.io/badge/license-Apache-blue) + +![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/android-maps-compose?color=green) +[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server] +[![GitHub License](https://img.shields.io/github/license/googlemaps/android-maps-compose?color=blue)](LICENSE) # Maps Compose 🗺 @@ -39,18 +43,18 @@ This repository includes a [sample app](app). To run it: +1. [Sign up for Google Maps Platform ][gmp-start] 1. Get a [Maps API key][api-key] -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. +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. If the `secrets.properties` file does not exist, create it in the same folder as the `local.default.properties` file. - ``` MAPS_API_KEY=YOUR_API_KEY ``` -3. Build and run +1. Build and run ## Documentation -You can learn more about all the extensions provided by this library by reading the [reference documents][Javadoc]. +See the [documentation] for a full list of classes and their methods. ## Usage @@ -474,24 +478,37 @@ The colors of the text, line, and shadow are also all configurable (e.g., based ## Contributing -Contributions are welcome and encouraged! See [contributing] for more info. +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]. + +## Terms of Service + +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]. + +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. ## Support 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). -This library adheres to [semantic versioning](https://semver.org/) to indicate when backwards-incompatible changes are introduced. +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. -If you find a bug, or have a feature request, please [file an issue] on GitHub. +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]. -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]. +You can also discuss this library on our [Discord server]. -[maps-sdk]: https://developers.google.com/maps/documentation/android-sdk [api-key]: https://developers.google.com/maps/documentation/android-sdk/get-api-key -[Discord server]: https://discord.gg/hYsWbmk -[Javadoc]: https://googlemaps.github.io/android-maps-compose -[contributing]: CONTRIBUTING.md +[devsite-guide]: https://developers.google.com/maps/documentation/android-sdk/utility +[gmp-start]: https://console.cloud.google.com/google/maps-apis/start +[maps-sdk]: https://developers.google.com/maps/documentation/android-sdk +[documentation]: https://googlemaps.github.io/android-maps-compose +[jetpack-compose]: https://developer.android.com/jetpack/compose + [code of conduct]: CODE_OF_CONDUCT.md +[contributing guide]: CONTRIBUTING.md +[developer community channels]: https://developers.google.com/maps/developer-community +[Discord server]: https://discord.gg/hYsWbmk [file an issue]: https://github.com/googlemaps/android-maps-compose/issues/new/choose [pull request]: https://github.com/googlemaps/android-maps-compose/compare -[jetpack-compose]: https://developer.android.com/jetpack/compose +[semantic versioning]: https://semver.org +[similar inquiry]: https://github.com/googlemaps/android-maps-compose/issues +[Terms of Service]: https://cloud.google.com/maps-platform/terms From 39ee660e59971e0466282276755e6751f7fb6445 Mon Sep 17 00:00:00 2001 From: wesley chun Date: Fri, 6 Dec 2024 01:46:57 -0800 Subject: [PATCH 2/5] fix: update README to template --- README.md | 49 +++++++++++++++++++++++++++++++++---------------- 1 file changed, 33 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 6b636929..0ca28868 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ -![Tests](https://github.com/googlemaps/android-maps-compose/actions/workflows/test.yml/badge.svg) +[![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) +![Tests/Build Status](https://github.com/googlemaps/android-maps-compose/workflows/Test/badge.svg) +![Release](https://github.com/googlemaps/android-maps-compose/workflows/Release/badge.svg) ![Stable](https://img.shields.io/badge/stability-stable-green) -[![Discord](https://img.shields.io/discord/676948200904589322)][Discord server] -![Apache-2.0](https://img.shields.io/badge/license-Apache-blue) + +![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/android-maps-compose?color=green) +[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server] +[![GitHub License](https://img.shields.io/github/license/googlemaps/android-maps-compose?color=blue)](LICENSE) # Maps Compose 🗺 @@ -39,18 +43,18 @@ This repository includes a [sample app](app). To run it: +1. [Sign up for Google Maps Platform ][gmp-start] 1. Get a [Maps API key][api-key] -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. +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. If the `secrets.properties` file does not exist, create it in the same folder as the `local.default.properties` file. - ``` MAPS_API_KEY=YOUR_API_KEY ``` -3. Build and run +1. Build and run ## Documentation -You can learn more about all the extensions provided by this library by reading the [reference documents][Javadoc]. +See the [documentation] for a full list of classes and their methods. ## Usage @@ -474,24 +478,37 @@ The colors of the text, line, and shadow are also all configurable (e.g., based ## Contributing -Contributions are welcome and encouraged! See [contributing] for more info. +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]. + +## Terms of Service + +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]. + +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. ## Support 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). -This library adheres to [semantic versioning](https://semver.org/) to indicate when backwards-incompatible changes are introduced. +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. -If you find a bug, or have a feature request, please [file an issue] on GitHub. +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]. -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]. +You can also discuss this library on our [Discord server]. -[maps-sdk]: https://developers.google.com/maps/documentation/android-sdk [api-key]: https://developers.google.com/maps/documentation/android-sdk/get-api-key -[Discord server]: https://discord.gg/hYsWbmk -[Javadoc]: https://googlemaps.github.io/android-maps-compose -[contributing]: CONTRIBUTING.md +[devsite-guide]: https://developers.google.com/maps/documentation/android-sdk/utility +[gmp-start]: https://console.cloud.google.com/google/maps-apis/start +[maps-sdk]: https://developers.google.com/maps/documentation/android-sdk +[documentation]: https://googlemaps.github.io/android-maps-compose +[jetpack-compose]: https://developer.android.com/jetpack/compose + [code of conduct]: CODE_OF_CONDUCT.md +[contributing guide]: CONTRIBUTING.md +[developer community channels]: https://developers.google.com/maps/developer-community +[Discord server]: https://discord.gg/hYsWbmk [file an issue]: https://github.com/googlemaps/android-maps-compose/issues/new/choose [pull request]: https://github.com/googlemaps/android-maps-compose/compare -[jetpack-compose]: https://developer.android.com/jetpack/compose +[semantic versioning]: https://semver.org +[similar inquiry]: https://github.com/googlemaps/android-maps-compose/issues +[Terms of Service]: https://cloud.google.com/maps-platform/terms From eeaaafd596f1dbd9f15842d34bbf82e8989ea06c Mon Sep 17 00:00:00 2001 From: wesley chun Date: Mon, 9 Dec 2024 20:01:28 -0800 Subject: [PATCH 3/5] fix: more README fixes from template --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0ca28868..5006c22f 100644 --- a/README.md +++ b/README.md @@ -488,7 +488,7 @@ This library is not a Google Maps Platform Core Service. Therefore, the Google M ## Support -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). +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. 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. @@ -505,10 +505,14 @@ You can also discuss this library on our [Discord server]. [code of conduct]: CODE_OF_CONDUCT.md [contributing guide]: CONTRIBUTING.md +[Deprecation Policy]: https://cloud.google.com/maps-platform/terms [developer community channels]: https://developers.google.com/maps/developer-community [Discord server]: https://discord.gg/hYsWbmk [file an issue]: https://github.com/googlemaps/android-maps-compose/issues/new/choose +[license]: LICENSE [pull request]: https://github.com/googlemaps/android-maps-compose/compare [semantic versioning]: https://semver.org [similar inquiry]: https://github.com/googlemaps/android-maps-compose/issues +[SLA]: https://cloud.google.com/maps-platform/terms/sla +[Technical Support Services Guidelines]: https://cloud.google.com/maps-platform/terms/tssg [Terms of Service]: https://cloud.google.com/maps-platform/terms From 818edcff8372a3844ce40c65fedc94702eaccca2 Mon Sep 17 00:00:00 2001 From: wesley chun Date: Tue, 10 Dec 2024 00:06:21 -0800 Subject: [PATCH 4/5] fix: more README fixes from template --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5006c22f..63781a69 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,12 @@ This repository contains [Jetpack Compose][jetpack-compose] components for the [ ## Requirements +* Android API level 21+ * Kotlin-enabled project * Jetpack Compose-enabled project (see [releases](https://github.com/googlemaps/android-maps-compose/releases) for the required version of Jetpack Compose) -* An [API key][api-key] -* API level 21+ +* [Sign up with Google Maps Platform] +* A Google Maps Platform [project] with the **Maps SDK for Android** enabled +* An [API key] associated with the project above ## Installation @@ -41,10 +43,8 @@ dependencies { This repository includes a [sample app](app). -To run it: +To run the demo app, ensure you've met the requirements above then: -1. [Sign up for Google Maps Platform ][gmp-start] -1. Get a [Maps API key][api-key] 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. If the `secrets.properties` file does not exist, create it in the same folder as the `local.default.properties` file. ``` @@ -496,8 +496,7 @@ If you find a bug, or have a feature request, please [file an issue] on GitHub. You can also discuss this library on our [Discord server]. -[api-key]: https://developers.google.com/maps/documentation/android-sdk/get-api-key -[devsite-guide]: https://developers.google.com/maps/documentation/android-sdk/utility +[API key]: https://developers.google.com/maps/documentation/android-sdk/get-api-key [gmp-start]: https://console.cloud.google.com/google/maps-apis/start [maps-sdk]: https://developers.google.com/maps/documentation/android-sdk [documentation]: https://googlemaps.github.io/android-maps-compose @@ -510,8 +509,10 @@ You can also discuss this library on our [Discord server]. [Discord server]: https://discord.gg/hYsWbmk [file an issue]: https://github.com/googlemaps/android-maps-compose/issues/new/choose [license]: LICENSE +[project]: https://developers.google.com/maps/documentation/android-sdk/cloud-setup [pull request]: https://github.com/googlemaps/android-maps-compose/compare [semantic versioning]: https://semver.org +[Sign up with Google Maps Platform]: https://console.cloud.google.com/google/maps-apis/start [similar inquiry]: https://github.com/googlemaps/android-maps-compose/issues [SLA]: https://cloud.google.com/maps-platform/terms/sla [Technical Support Services Guidelines]: https://cloud.google.com/maps-platform/terms/tssg From 5a654f4367de0cc2d1c77cd47576b7fc023c2bcb Mon Sep 17 00:00:00 2001 From: wesley chun Date: Mon, 30 Dec 2024 22:01:03 -0800 Subject: [PATCH 5/5] chore: more README fixes from template --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 63781a69..b67e1c74 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ [![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) -![Tests/Build Status](https://github.com/googlemaps/android-maps-compose/workflows/Test/badge.svg) ![Release](https://github.com/googlemaps/android-maps-compose/workflows/Release/badge.svg) ![Stable](https://img.shields.io/badge/stability-stable-green) +[![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) -![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/android-maps-compose?color=green) +![Contributors](https://img.shields.io/github/contributors/googlemaps/android-maps-compose?color=green) +[![License](https://img.shields.io/github/license/googlemaps/android-maps-compose?color=blue)][license] +[![StackOverflow](https://img.shields.io/stackexchange/stackoverflow/t/google-maps?color=orange&label=google-maps&logo=stackoverflow)](https://stackoverflow.com/questions/tagged/google-maps) [![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server] -[![GitHub License](https://img.shields.io/github/license/googlemaps/android-maps-compose?color=blue)](LICENSE) # Maps Compose 🗺 @@ -20,7 +21,7 @@ This repository contains [Jetpack Compose][jetpack-compose] components for the [ * Jetpack Compose-enabled project (see [releases](https://github.com/googlemaps/android-maps-compose/releases) for the required version of Jetpack Compose) * [Sign up with Google Maps Platform] * A Google Maps Platform [project] with the **Maps SDK for Android** enabled -* An [API key] associated with the project above +- An [API key] associated with the project above ... follow the [API key instructions] if you're new to the process ## Installation @@ -497,12 +498,12 @@ If you find a bug, or have a feature request, please [file an issue] on GitHub. You can also discuss this library on our [Discord server]. [API key]: https://developers.google.com/maps/documentation/android-sdk/get-api-key -[gmp-start]: https://console.cloud.google.com/google/maps-apis/start +[API key instructions]: https://developers.google.com/maps/documentation/android-sdk/config#step_3_add_your_api_key_to_the_project [maps-sdk]: https://developers.google.com/maps/documentation/android-sdk [documentation]: https://googlemaps.github.io/android-maps-compose [jetpack-compose]: https://developer.android.com/jetpack/compose -[code of conduct]: CODE_OF_CONDUCT.md +[code of conduct]: ?tab=coc-ov-file#readme [contributing guide]: CONTRIBUTING.md [Deprecation Policy]: https://cloud.google.com/maps-platform/terms [developer community channels]: https://developers.google.com/maps/developer-community