Skip to content

Commit bb5865e

Browse files
authored
chore: fix code snippet for installation (#1202)
* chore: fix code snippet for installation chore: update release config to update install snippet version number chore: update and reorganize README
1 parent 2bcabfb commit bb5865e

File tree

3 files changed

+27
-16
lines changed

3 files changed

+27
-16
lines changed

.releaserc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
branches:
2-
- main
2+
- main, devsite
33
plugins:
44
- "@semantic-release/commit-analyzer"
55
- "@semantic-release/release-notes-generator"
@@ -9,6 +9,10 @@ plugins:
99
- "build.gradle"
1010
from: "\\bversion = '.*'"
1111
to: "version = '${nextRelease.version}'"
12+
- files:
13+
- "build.gradle"
14+
from: "com.google.maps.android:android-maps-utils:([0-9]+).([0-9]+).([0-9]+)"
15+
to: "com.google.maps.android:android-maps-utils:${nextRelease.version}'"
1216
- files:
1317
- "README.md"
1418
from: ":([0-9]+).([0-9]+).([0-9]+)"

README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,6 @@ range of applications using the [Google Maps SDK for Android][android-site].
2626

2727
You can also find Kotlin extensions for this library [here][android-maps-ktx].
2828

29-
## Developer Documentation
30-
31-
The generated [reference docs][javadoc] for a full list of classes and their methods.
32-
33-
Written guides for using the utilities are published in
34-
[Google Maps Platform documentation][devsite-guide].
35-
3629
## Requirements
3730

3831
* Android API level 19+
@@ -44,6 +37,14 @@ Written guides for using the utilities are published in
4437
dependencies {
4538
// Utilities for Maps SDK for Android (requires Google Play Services)
4639
implementation 'com.google.maps.android:android-maps-utils:3.4.0'
40+
41+
// Optionally add the Kotlin Extensions (KTX) for full Kotlin language support
42+
// See latest version at https://github.com/googlemaps/android-maps-ktx
43+
// implementation 'com.google.maps.android:maps-utils-ktx:<latest-version>'
44+
45+
// Make sure to also include the latest version of the Maps SDK for Android
46+
// See latest version at https://goo.gle/android-maps-sdk-version
47+
// implementation 'com.google.android.gms:play-services-maps:<latest-version>'
4748
}
4849
```
4950

@@ -60,14 +61,23 @@ To run the demo app, you'll have to:
6061
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
6162
1. Build and run the `debug` variant for the Maps SDK for Android version
6263

64+
## Documentation
65+
66+
See the generated [reference docs][javadoc] for a full list of classes and their methods.
67+
68+
Written guides for using the utilities are published in
69+
[Google Maps Platform documentation][devsite-guide].
70+
6371
<details>
6472
<summary><strong>Migration Guide from v0.x to 1.0</strong></summary>
6573

66-
## Migration Guide from v0.x to 1.0
74+
### Migration Guide from v0.x to 1.0
6775

6876
Improvements made in version [1.0.0](https://github.com/googlemaps/android-maps-utils/releases/tag/1.0.0) of the library to support multiple layers on the map caused breaking changes to versions prior to it. These changes also modify behaviors that are documented in the [Maps SDK for Android Maps documentation](https://developers.google.com/maps/documentation/android-sdk/intro) site. This section outlines all those changes and how you can migrate to use this library since version 1.0.0.
6977

7078

79+
## Usage
80+
7181
### Adding Click Events
7282

7383
Click events originate in the layer-specific object that added the marker/ground overlay/polyline/polygon. In each layer, the click handlers are passed to the marker, ground overlay, polyline, or polygon `Collection` object.
@@ -286,7 +296,7 @@ Encounter an issue while using this library?
286296
If you find a bug or have a feature request, please [file an issue].
287297
Or, if you'd like to contribute, send us a [pull request] and refer to our [code of conduct].
288298

289-
You can also reach us on our [Discord channel].
299+
You can also discuss this library on our [Discord server].
290300

291301
For more information, check out the detailed guide on the
292302
[Google Developers site][devsite-guide].

demo/build.gradle

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
import org.apache.tools.ant.filters.ConcatFilter
2-
31
/**
42
* Copyright 2020 Google Inc.
53
*
@@ -50,13 +48,12 @@ android {
5048
dependencies {
5149

5250
// [START_EXCLUDE silent]
53-
implementation 'androidx.appcompat:appcompat:1.7.0-alpha01'
54-
implementation 'androidx.lifecycle:lifecycle-extensions:2.2.0'
55-
56-
// GMS
5751
implementation 'com.google.android.gms:play-services-maps:18.1.0'
5852
implementation project(':library')
5953

54+
implementation 'androidx.appcompat:appcompat:1.7.0-alpha01'
55+
implementation 'androidx.lifecycle:lifecycle-extensions:2.2.0'
56+
6057
implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:2.5.1"
6158
implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
6259
// [END_EXCLUDE]

0 commit comments

Comments
 (0)