Skip to content

Commit 818edcf

Browse files
committed
fix: more README fixes from template
1 parent eeaaafd commit 818edcf

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,12 @@ This repository contains [Jetpack Compose][jetpack-compose] components for the [
1515

1616
## Requirements
1717

18+
* Android API level 21+
1819
* Kotlin-enabled project
1920
* Jetpack Compose-enabled project (see [releases](https://github.com/googlemaps/android-maps-compose/releases) for the required version of Jetpack Compose)
20-
* An [API key][api-key]
21-
* API level 21+
21+
* [Sign up with Google Maps Platform]
22+
* A Google Maps Platform [project] with the **Maps SDK for Android** enabled
23+
* An [API key] associated with the project above
2224

2325
## Installation
2426

@@ -41,10 +43,8 @@ dependencies {
4143

4244
This repository includes a [sample app](app).
4345

44-
To run it:
46+
To run the demo app, ensure you've met the requirements above then:
4547

46-
1. [Sign up for Google Maps Platform ][gmp-start]
47-
1. Get a [Maps API key][api-key]
4848
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.
4949
If the `secrets.properties` file does not exist, create it in the same folder as the `local.default.properties` file.
5050
```
@@ -496,8 +496,7 @@ If you find a bug, or have a feature request, please [file an issue] on GitHub.
496496

497497
You can also discuss this library on our [Discord server].
498498

499-
[api-key]: https://developers.google.com/maps/documentation/android-sdk/get-api-key
500-
[devsite-guide]: https://developers.google.com/maps/documentation/android-sdk/utility
499+
[API key]: https://developers.google.com/maps/documentation/android-sdk/get-api-key
501500
[gmp-start]: https://console.cloud.google.com/google/maps-apis/start
502501
[maps-sdk]: https://developers.google.com/maps/documentation/android-sdk
503502
[documentation]: https://googlemaps.github.io/android-maps-compose
@@ -510,8 +509,10 @@ You can also discuss this library on our [Discord server].
510509
[Discord server]: https://discord.gg/hYsWbmk
511510
[file an issue]: https://github.com/googlemaps/android-maps-compose/issues/new/choose
512511
[license]: LICENSE
512+
[project]: https://developers.google.com/maps/documentation/android-sdk/cloud-setup
513513
[pull request]: https://github.com/googlemaps/android-maps-compose/compare
514514
[semantic versioning]: https://semver.org
515+
[Sign up with Google Maps Platform]: https://console.cloud.google.com/google/maps-apis/start
515516
[similar inquiry]: https://github.com/googlemaps/android-maps-compose/issues
516517
[SLA]: https://cloud.google.com/maps-platform/terms/sla
517518
[Technical Support Services Guidelines]: https://cloud.google.com/maps-platform/terms/tssg

0 commit comments

Comments
 (0)