Skip to content

Commit

Permalink
Prepared for 2.1.0 releases
Browse files Browse the repository at this point in the history
  • Loading branch information
SupasinTatiyanupanwong committed Aug 22, 2021
1 parent b19b468 commit d95739b
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 28 deletions.
51 changes: 27 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,33 @@
[![javadoc](https://javadoc.io/badge2/dev.supasintatiyanupanwong.libraries.android.kits.maps/maps-core/javadoc.svg)](https://javadoc.io/doc/dev.supasintatiyanupanwong.libraries.android.kits.maps/maps-core)
[![license](https://img.shields.io/github/license/SupasinTatiyanupanwong/map-kit-android.svg)](https://www.apache.org/licenses/LICENSE-2.0)

Map Kit is an abstraction wrapper that encapsulates Android's Maps APIs of Google Maps SDK for Android, HUAWEI Map Kit, and Amazon Maps SDK.
Map Kit is an abstraction wrapper that encapsulates Android's Maps APIs of Google Maps SDK for Android, Amazon Maps SDK, and HUAWEI Map Kit.

## Architecture

The library consists of 4 artifacts; `maps-core`, `maps-google`, `maps-huawei`, and `maps-amazon`.
The library consists of 4 artifacts; `maps-core`, `maps-google`, `maps-amazon`, and `maps-huawei`.

`maps-core` artifact provides an abstraction interface to interact with Maps APIs.

`maps-google` artifact provides the Google Maps SDK for Android integration to Map Kit.

`maps-huawei` artifact provides the HUAWEI Map Kit integration to Map Kit.

`maps-amazon` artifact provides the Amazon Maps SDK integration to Map Kit.

`maps-huawei` artifact provides the HUAWEI Map Kit integration to Map Kit.

## Usage

### Migrating from the existing APIs

| Google Maps SDK for Android | HUAWEI Map Kit | Map Kit |
|:--------------------------------- |:------------------------- |:------------------------------------------------------------ |
| ``com.google.android.gms.maps.*`` | ``com.huawei.hms.maps.*`` | ``dev.supasintatiyanupanwong.libraries.android.kits.maps.*`` |
| ``SupportMapFragment`` | ``SupportMapFragment`` | ``MapFragment`` |
| ``GoogleMap`` | ``HuaweiMap`` | ``MapClient`` |
| ``new LatLng()`` | ``new LatLng()`` | ``MapKit.newLatLng()`` |
| ``new *Options()`` | ``new *Options()`` | ``MapKit.new*Options()`` |
| ``*.builder()`` | ``*.builder()`` | ``MapKit.new*Builder()`` |
| ``*Factory.*()`` | ``*Factory.*()`` | ``MapKit.get*Factory().*()`` |
| ``Tile.NO_TILE`` | ``Tile.NO_TILE`` | ``MapKit.noTile()`` |
| Google Maps SDK for Android | Amazon Maps SDK | HUAWEI Map Kit | Map Kit |
|:--------------------------- |:---------------------- |:---------------------- |:---------------------------- |
| ``SupportMapFragment`` | ``SupportMapFragment`` | ``SupportMapFragment`` | ``MapFragment`` |
| ``GoogleMap`` | ``AmazonMap`` | ``HuaweiMap`` | ``MapClient`` |
| ``new LatLng()`` | ``new LatLng()`` | ``new LatLng()`` | ``MapKit.newLatLng()`` |
| ``new *Options()`` | ``new *Options()`` | ``new *Options()`` | ``MapKit.new*Options()`` |
| ``*.builder()`` | ``*.builder()`` | ``*.builder()`` | ``MapKit.new*Builder()`` |
| ``*Factory.*()`` | ``*Factory.*()`` | ``*Factory.*()`` | ``MapKit.get*Factory().*()`` |
| ``Tile.NO_TILE`` | ``Tile.NO_TILE`` | ``Tile.NO_TILE`` | ``MapKit.noTile()`` |

### Limitation

Expand All @@ -45,14 +44,17 @@ Add the dependencies for the artifacts you need in the `build.gradle` file for y

```groovy
dependencies {
// To use the Google Maps SDK for Android via Map Kit
implementation 'dev.supasintatiyanupanwong.libraries.android.kits.maps:maps-google:2.0.0'
// Optional - To grant access to the Map Kit API without platform specific implementation
implementation 'dev.supasintatiyanupanwong.libraries.android.kits.maps:maps-core:2.1.0'
// To use the HUAWEI Map Kit via Map Kit
implementation 'dev.supasintatiyanupanwong.libraries.android.kits.maps:maps-huawei:2.0.0'
// To use the Google Maps SDK for Android via Map Kit
implementation 'dev.supasintatiyanupanwong.libraries.android.kits.maps:maps-google:2.1.0'
// To use the Amazon Maps SDK via Map Kit
implementation 'dev.supasintatiyanupanwong.libraries.android.kits.maps:maps-amazon:2.0.0-alpha01'
implementation 'dev.supasintatiyanupanwong.libraries.android.kits.maps:maps-amazon:2.1.0-alpha01'
// To use the HUAWEI Map Kit via Map Kit
implementation 'dev.supasintatiyanupanwong.libraries.android.kits.maps:maps-huawei:2.1.0'
}
```

Expand All @@ -66,15 +68,15 @@ android {
flavorDimensions 'vendor'
productFlavors {
google
huawei { applicationIdSuffix '.huawei' }
amazon { applicationIdSuffix '.amazon' }
huawei { applicationIdSuffix '.huawei' }
}
}
dependencies {
googleImplementation 'dev.supasintatiyanupanwong.libraries.android.kits.maps:maps-google:2.0.0'
huaweiImplementation 'dev.supasintatiyanupanwong.libraries.android.kits.maps:maps-huawei:2.0.0'
amazonImplementation 'dev.supasintatiyanupanwong.libraries.android.kits.maps:maps-amazon:2.0.0-alpha01'
googleImplementation 'dev.supasintatiyanupanwong.libraries.android.kits.maps:maps-google:2.1.0'
amazonImplementation 'dev.supasintatiyanupanwong.libraries.android.kits.maps:maps-amazon:2.1.0-alpha01'
huaweiImplementation 'dev.supasintatiyanupanwong.libraries.android.kits.maps:maps-huawei:2.1.0'
}
```

Expand All @@ -85,12 +87,13 @@ For more information about dependencies, see [Add build dependencies](https://de
## Additional documentation

* [Maps SDK for Android - Google Developer](https://developers.google.com/maps/documentation/android-sdk/intro)
* [Amazon Maps SDK - Amazon Appstore Developer](https://developer.amazon.com/docs/maps/understand.html)
* [Map Kit - HMS Core - HUAWEI Developer](https://developer.huawei.com/consumer/en/hms/huawei-MapKit)

## Feedback

Your feedback helps make Map Kit better. Let us know if you discover new issues or have ideas for improving this library.
Please take a look at the [existing issues](https://github.com/SupasinTatiyanupanwong/map-kit-android/issues) in this library before you create a new one.
Please take a look at the [existing issues](https://github.com/SupasinTatiyanupanwong/map-kit-android/issues) or the [existing discussions](https://github.com/SupasinTatiyanupanwong/map-kit-android/discussions) in this library before you create a new one.

## License

Expand Down
2 changes: 1 addition & 1 deletion maps-amazon/gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ POM_ARTIFACT_ID=maps-amazon
POM_NAME=Map Kit (Amazon)
POM_DESCRIPTION=Library providing Amazon Maps integration to Map Kit.

VERSION_NAME=2.0.0-alpha01
VERSION_NAME=2.1.0-alpha01
2 changes: 1 addition & 1 deletion maps-core/gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ POM_ARTIFACT_ID=maps-core
POM_NAME=Map Kit (Core)
POM_DESCRIPTION=Library encapsulating Map APIs for Android.

VERSION_NAME=2.0.0
VERSION_NAME=2.1.0
2 changes: 1 addition & 1 deletion maps-google/gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ POM_ARTIFACT_ID=maps-google
POM_NAME=Map Kit (Google)
POM_DESCRIPTION=Library providing Google Maps integration to Map Kit.

VERSION_NAME=2.0.0
VERSION_NAME=2.1.0
2 changes: 1 addition & 1 deletion maps-huawei/gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ POM_ARTIFACT_ID=maps-huawei
POM_NAME=Map Kit (Huawei)
POM_DESCRIPTION=Library providing Huawei Maps integration to Map Kit.

VERSION_NAME=2.0.0
VERSION_NAME=2.1.0

0 comments on commit d95739b

Please sign in to comment.