From ea884f56b1d4b8c78dafa21747d50370f782208f Mon Sep 17 00:00:00 2001 From: Emux Date: Mon, 26 Sep 2016 11:02:27 +0300 Subject: [PATCH] Update integration guide --- docs/Integration.md | 48 ++++++++++++++++++++------------------------- 1 file changed, 21 insertions(+), 27 deletions(-) diff --git a/docs/Integration.md b/docs/Integration.md index 0e5144da..171c46b1 100644 --- a/docs/Integration.md +++ b/docs/Integration.md @@ -1,6 +1,8 @@ # Integration guide -This article describes how to integrate the library in your project. Check for current version at Maven badge on main page. +This article describes how to integrate the library in your project. + +Current version is [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.mapsforge/vtm/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.mapsforge/vtm) ## Gradle @@ -24,7 +26,7 @@ compile 'com.caverock:androidsvg:1.2.2-beta-1' Detailed iOS instructions can be found [here](ios.md). -### Java +### Desktop ```groovy compile 'org.mapsforge:vtm-gdx:[CURRENT-VERSION]' compile 'org.mapsforge:vtm-desktop:[CURRENT-VERSION]' @@ -41,6 +43,23 @@ compile 'org.lwjgl.lwjgl:lwjgl-platform:2.9.3:natives-windows' compile 'com.kitfox.svg:svg-salamander:1.0' ``` +## Snapshots + +We publish regularly SNAPSHOT builds to Sonatype OSS Repository Hosting. + +You need to add the repository: +```groovy +repositories { + maven { url "https://oss.sonatype.org/content/repositories/snapshots/" } +} +``` + +And declare the dependencies like: +```groovy +compile 'org.mapsforge:vtm:master-SNAPSHOT' +... +``` + ## Maven The dependencies for Maven are declared in a similar way. For example: @@ -53,31 +72,6 @@ The dependencies for Maven are declared in a similar way. For example: ``` -## Snapshots - -We publish regularly SNAPSHOT builds to Sonatype OSS Repository Hosting. To use `master-SNAPSHOT` version add as repository, e.g. in Gradle: -```groovy -maven { url "https://oss.sonatype.org/content/repositories/snapshots/" } -``` - -## JitPack - -We support also [JitPack](https://jitpack.io/#mapsforge/vtm) for releases or SNAPSHOT builds. - -For example in order to include the `vtm` module `master-SNAPSHOT` with Gradle. - -Add as repository: -```groovy -maven { url "https://jitpack.io" } -``` - -And declare as dependency: -```groovy -compile 'com.github.mapsforge.vtm:vtm:master-SNAPSHOT' -``` - -The same syntax applies for all modules. And with similar way you can declare the dependencies in Maven too. - ## Jars You can find jars (regular and with dependencies) in Maven Central or Snapshots repositories.