Skip to content

Commit

Permalink
Update README.md (#73)
Browse files Browse the repository at this point in the history
  • Loading branch information
ravenfeld authored Oct 18, 2024
1 parent 256967a commit 3bad160
Show file tree
Hide file tree
Showing 7 changed files with 65 additions and 112 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ repositories {
}
dependencies {
implementation 'org.maplibre.android:{PLUGIN_NAME}-v{MAJOR_MAPS_SDK_VERSION_NUMBER}:PLUGIN_VERSION_NUMBER'
implementation 'org.maplibre.gl:android-{PLUGIN_NAME}-v{MAJOR_MAPS_SDK_VERSION_NUMBER}:PLUGIN_VERSION_NUMBER'
}
```

Expand Down
23 changes: 4 additions & 19 deletions plugin-annotation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,34 +17,19 @@ repositories {
```

Add [the latest version](https://central.sonatype.com/artifact/org.maplibre.gl/android-plugin-annotation-v9/versions) as a dependency to your project.

In the app-level `build.gradle` file:

```groovy
dependencies {
implementation 'org.maplibre.gl:android-plugin-annotation-v9:3.0.1'
implementation 'org.maplibre.gl:android-plugin-annotation-v9:3.0.2'
}
```

```kotlin
dependencies {
implementation("org.maplibre.gl:android-plugin-annotation-v9:3.0.1")
}
```

The annotation plugin is published to Maven Central and nightly SNAPSHOTs are available on Sonatype:

```
// In the root build.gradle file
repositories {
mavenCentral()
maven { url "http://oss.sonatype.org/content/repositories/snapshots/" }
}
...
// In the app build.gradle file
dependencies {
implementation 'com.maplibre.maplibresdk:maplibre-android-plugin-annotation-v9:0.10.0-SNAPSHOT'
implementation("org.maplibre.gl:android-plugin-annotation-v9:3.0.2")
}
```

Expand Down
30 changes: 12 additions & 18 deletions plugin-building/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,34 +10,28 @@ This plugin is currently unmaintained.

To use the building plugin you include it in your `build.gradle` file.

```
// In the root build.gradle file
In the root `build.gradle` file:

```groovy
repositories {
mavenCentral()
}
...
// In the app build.gradle file
dependencies {
implementation 'com.maplibre.maplibresdk:maplibre-android-plugin-building-v9:0.7.0'
}
```

The building plugins is published to Maven Central and nightly SNAPSHOTs are available on Sonatype:
Add [the latest version](https://central.sonatype.com/artifact/org.maplibre.gl/android-plugin-building-v9/versions) as a dependency to your project.

```
// In the root build.gradle file
repositories {
mavenCentral()
maven { url "http://oss.sonatype.org/content/repositories/snapshots/" }
}
In the app-level `build.gradle` file:

...
```groovy
dependencies {
implementation 'org.maplibre.gl:android-plugin-building-v9:3.0.2'
}
```

// In the app build.gradle file
```kotlin
dependencies {
implementation 'com.maplibre.maplibresdk:maplibre-android-plugin-building-v9:0.8.0-SNAPSHOT'
implementation("org.maplibre.gl:android-plugin-building-v9:3.0.2")
}
```

Expand Down
32 changes: 12 additions & 20 deletions plugin-localization/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,36 +10,28 @@ This plugin is currently unmaintained.

To use the localization plugin, you include it in your `build.gradle` file.

```gradle
// In the root build.gradle file
In the root `build.gradle` file:

```groovy
repositories {
mavenCentral()
google()
}
...
// In the app build.gradle file
dependencies {
implementation 'com.maplibre.maplibresdk:maplibre-android-plugin-localization-v9:0.12.0'
}
```

The location layer plugin is published to Maven Central and nightly SNAPSHOTs are available on Sonatype:
Add [the latest version](https://central.sonatype.com/artifact/org.maplibre.gl/android-plugin-localization-v9/versions) as a dependency to your project.

```gradle
// In the root build.gradle file
repositories {
mavenCentral()
google()
maven { url "http://oss.sonatype.org/content/repositories/snapshots/" }
}
In the app-level `build.gradle` file:

...
```groovy
dependencies {
implementation 'org.maplibre.gl:android-plugin-localization-v9:3.0.2'
}
```

// In the app build.gradle file
```kotlin
dependencies {
implementation 'com.maplibre.maplibresdk:maplibre-android-plugin-localization-v9:0.13.0-SNAPSHOT'
implementation("org.maplibre.gl:android-plugin-localization-v9:3.0.2")
}
```

Expand Down
30 changes: 12 additions & 18 deletions plugin-markerview/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,34 +12,28 @@ Please be aware that Android views are the less performant and less customizable

To use the MarkerView plugin, you include its dependency in your `build.gradle` file.

```
// In the root build.gradle file
In the root `build.gradle` file:

```groovy
repositories {
mavenCentral()
}
...
// In the app build.gradle file
dependencies {
implementation 'com.maplibre.maplibresdk:maplibre-android-plugin-markerview-v9:0.4.0'
}
```

The MarkerView plugin is published to Maven Central and nightly SNAPSHOTs are available on Sonatype:
Add [the latest version](https://central.sonatype.com/artifact/org.maplibre.gl/android-plugin-markerview-v9/versions) as a dependency to your project.

```
// In the root build.gradle file
repositories {
mavenCentral()
maven { url "http://oss.sonatype.org/content/repositories/snapshots/" }
}
In the app-level `build.gradle` file:

...
```groovy
dependencies {
implementation 'org.maplibre.gl:android-plugin-markerview-v9:3.0.2'
}
```

// In the app build.gradle file
```kotlin
dependencies {
implementation 'com.maplibre.maplibresdk:maplibre-android-plugin-markerview-v9:0.5.0-SNAPSHOT'
implementation("org.maplibre.gl:android-plugin-markerview-v9:3.0.2")
}
```

Expand Down
30 changes: 12 additions & 18 deletions plugin-offline/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,34 +10,28 @@ This plugin is currently unmaintained.

To use the offline plugin you include it in your `build.gradle` file.

```
// In the root build.gradle file
In the root `build.gradle` file:

```groovy
repositories {
mavenCentral()
}
...
// In the app build.gradle file
dependencies {
implementation 'com.maplibre.maplibresdk:maplibre-android-plugin-offline-v9:0.7.0'
}
```

The marker cluster plugin is published to Maven Central and nightly SNAPSHOTs are available on Sonatype:
Add [the latest version](https://central.sonatype.com/artifact/org.maplibre.gl/android-plugin-offline-v9/versions) as a dependency to your project.

```
// In the root build.gradle file
repositories {
mavenCentral()
maven { url "http://oss.sonatype.org/content/repositories/snapshots/" }
}
In the app-level `build.gradle` file:

...
```groovy
dependencies {
implementation 'org.maplibre.gl:android-plugin-offline-v9:3.0.2'
}
```

// In the app build.gradle file
```kotlin
dependencies {
implementation 'com.maplibre.maplibresdk:maplibre-android-plugin-offline-v9:0.8.0-SNAPSHOT'
implementation("org.maplibre.gl:android-plugin-offline-v9:3.0.2")
}
```

Expand Down
30 changes: 12 additions & 18 deletions plugin-scalebar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,34 +10,28 @@ This plugin is currently unmaintained.

To use the scale bar plugin, you include it in your `build.gradle` file.

```
// In the root build.gradle file
In the root `build.gradle` file:

```groovy
repositories {
mavenCentral()
}
...
// In the app build.gradle file
dependencies {
implementation 'com.maplibre.maplibresdk:maplibre-android-plugin-scalebar-v9:0.5.0'
}
```

The scale bar plugin is published to Maven Central and nightly SNAPSHOTs are available on Sonatype:
Add [the latest version](https://central.sonatype.com/artifact/org.maplibre.gl/android-plugin-scalebar-v9/versions) as a dependency to your project.

```
// In the root build.gradle file
repositories {
mavenCentral()
maven { url "http://oss.sonatype.org/content/repositories/snapshots/" }
}
In the app-level `build.gradle` file:

...
```groovy
dependencies {
implementation 'org.maplibre.gl:android-plugin-scalebar-v9:3.0.2'
}
```

// In the app build.gradle file
```kotlin
dependencies {
implementation 'com.maplibre.maplibresdk:maplibre-android-plugin-scalebar-v9:0.6.0-SNAPSHOT'
implementation("org.maplibre.gl:android-plugin-scalebar-v9:3.0.2")
}
```

Expand Down

0 comments on commit 3bad160

Please sign in to comment.