Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #110

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ To incorporate OMH Maps into your project, you have two options: utilize the OMH
2. Save the file and [sync Project with Gradle Files](https://developer.android.com/studio/build#sync-files).

### Configure the OMH Core plugin
In this sample app, we utilize the `omhConfig` definition to expand the capabilities of the existing Android Studio variants. For more details, refer to the [OMH Core Plugin Docs](https://github.com/openmobilehub/omh-core/tree/release/1.0).
In this sample app, we utilize the `omhConfig` definition to expand the capabilities of the existing Android Studio variants. For more details, refer to the [OMH Core Plugin Docs](https://github.com/openmobilehub/omh-core).

#### Basic configuration

Expand All @@ -135,24 +135,24 @@ In this sample app, we utilize the `omhConfig` definition to expand the capabili
bundle("singleBuild") {
maps {
gmsService {
dependency = "com.openmobilehub.android:maps-api-googlemaps:1.0"
dependency = "com.openmobilehub.android:maps-api-googlemaps:1.0.2-beta"
}
nonGmsService {
dependency = "com.openmobilehub.android:maps-api-openstreetmap:1.0"
dependency = "com.openmobilehub.android:maps-api-openstreetmap:1.0.2-beta"
}
}
}
bundle("gms") {
maps {
gmsService {
dependency = "com.openmobilehub.android:maps-api-googlemaps:1.0"
dependency = "com.openmobilehub.android:maps-api-googlemaps:1.0.2-beta"
}
}
}
bundle("nonGms") {
maps {
nonGmsService {
dependency = "com.openmobilehub.android:maps-api-openstreetmap:1.0"
dependency = "com.openmobilehub.android:maps-api-openstreetmap:1.0.2-beta"
}
}
}
Expand All @@ -167,21 +167,21 @@ In this sample app, we utilize the `omhConfig` definition to expand the capabili
##### Variant singleBuild
- Define the `Service`. In this example is maps.
- Define the `ServiceDetails`. In this example are `gmsService` and `nonGmsService`.
- Define the dependency and the path. In this example are `com.openmobilehub.android:maps-api-googlemaps:1.0"` and `com.openmobilehub.android:maps-api-openstreetmap:1.0`.
- Define the dependency and the path. In this example are `com.openmobilehub.android:maps-api-googlemaps:.1.0.2-beta"` and `com.openmobilehub.android:maps-api-openstreetmap:1.0.2-beta`.

**Note: It's important to observe how a single build encompasses both GMS and Non-GMS configurations.**

##### Variant gms
- Define the `Service`. In this example is maps.
- Define the `ServiceDetails` . In this example is `gmsService`.
- Define the dependency and the path. In this example is `com.openmobilehub.android:maps-api-googlemaps:1.0"`.
- Define the dependency and the path. In this example is `com.openmobilehub.android:maps-api-googlemaps:1.0.2-beta"`.

**Note:** gms build covers only GMS (Google Mobile Services).

##### Variant nonGms
- Define the `Service`. In this example is maps.
- Define the `ServiceDetails` . In this example is `nonGmsService`.
- Define the dependency and the path. In this example is `com.openmobilehub.android:maps-api-openstreetmap:1.0`.
- Define the dependency and the path. In this example is `com.openmobilehub.android:maps-api-openstreetmap:1.0.2-beta`.

**Note:** nonGms build covers only Non-GMS configurations.

Expand Down Expand Up @@ -371,7 +371,7 @@ This repository includes a [maps-sample](/maps-sample) that demonstrates the fun
OMH Maps SDK is open-source, promoting community collaboration and plugin support from other map providers to enhance capabilities and expand supported map services. More details can be found at https://github.com/openmobilehub/omh-maps/wiki.

# Contributing
Please contribute! We will gladly review any pull requests. Make sure to read the [Contributing](https://github.com/openmobilehub/omh-maps/blob/release/1.0/CONTRIBUTING.md) page first though.
Please contribute! We will gladly review any pull requests. Make sure to read the [Contributing](https://github.com/openmobilehub/omh-maps/blob/main/CONTRIBUTING.md) page first though.

# License
```
Expand Down