Skip to content

Commit 2989f17

Browse files
committed
fix: more README fixes from template
1 parent aca66a8 commit 2989f17

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ You can also find Kotlin extensions for this library in [Maps Android KTX][andro
3333
## Requirements
3434

3535
* Android API level 21+
36-
- An [API key][api-key]
36+
* [Sign up with Google Maps Platform]
37+
* A Google Maps Platform [project] with the **Maps SDK for Android** enabled
38+
* An [API key] associated with the project above
3739

3840
## Installation
3941

@@ -56,24 +58,21 @@ dependencies {
5658

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

59-
To run the demo app, you'll have to:
60-
61-
1. [Sign up for Google Maps Platform ][gmp-start]
62-
1. [Get a Maps API key][api-key]
61+
To run the demo app, ensure you've met the requirements above then:
62+
1. Clone the repository
6363
1. Add a file `local.properties` in the root project (this file should *NOT* be under version control to protect your API key)
64-
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
64+
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 earlier
6565
1. Build and run the `debug` variant for the Maps SDK for Android version
6666

6767
## Documentation
6868

6969
See the [documentation] for a full list of classes and their methods.
7070

71-
## Usage
72-
7371
Full guides for using the utilities are published in
74-
[Google Maps Platform documentation][devsite-guide].
72+
[Google Maps Platform documentation](https://developers.google.com/maps/documentation/android-sdk/utility).
73+
74+
## Usage
7575

76-
<details>
7776
<summary>Marker utilities</summary>
7877

7978
### Marker utilities
@@ -362,8 +361,7 @@ If you find a bug, or have a feature request, please [file an issue] on GitHub.
362361

363362
You can also discuss this library on our [Discord server].
364363

365-
[api-key]: https://developers.google.com/maps/documentation/android-sdk/get-api-key
366-
[devsite-guide]: https://developers.google.com/maps/documentation/android-sdk/utility
364+
[API key]: https://developers.google.com/maps/documentation/android-sdk/get-api-key
367365
[gmp-start]: https://console.cloud.google.com/google/maps-apis/start
368366
[maps-sdk]: https://developers.google.com/maps/documentation/android-sdk
369367
[documentation]: https://googlemaps.github.io/android-maps-utils
@@ -376,8 +374,10 @@ You can also discuss this library on our [Discord server].
376374
[Discord server]: https://discord.gg/hYsWbmk
377375
[file an issue]: https://github.com/googlemaps/android-maps-utils/issues/new/choose
378376
[license]: LICENSE
377+
[project]: https://developers.google.com/maps/documentation/android-sdk/cloud-setup
379378
[pull request]: https://github.com/googlemaps/android-maps-utils/compare
380379
[semantic versioning]: https://semver.org
380+
[Sign up with Google Maps Platform]: https://console.cloud.google.com/google/maps-apis/start
381381
[similar inquiry]: https://github.com/googlemaps/android-maps-utils/issues
382382
[SLA]: https://cloud.google.com/maps-platform/terms/sla
383383
[Technical Support Services Guidelines]: https://cloud.google.com/maps-platform/terms/tssg

0 commit comments

Comments
 (0)