Merge pull request #2 from SimonIT/gwt-compatibility

remove string format, it's not available on gwt

1 files changed, 31 insertions, 0 deletions

diff --git a/README.md b/README.md
index c2df9ae..5a67a5f 100644
--- a/README.md
+++ b/README.md
@@ -12,3 +12,34 @@ code is mainly extracted from https://github.com/jeremyz/rustanddust
     - various animations
     - path, movement, line of sight computation
 
+## install
+
+Add the repository:
+```groovy
+	allprojects {
+		repositories {
+			maven { url 'https://jitpack.io' }
+		}
+	}
+```
+Add the dependency to all subprojects: (You can replace `master-SNAPSHOT` with a tag from github)
+```groovy
+	dependencies {
+	        implementation 'com.github.jeremyz:gdx-boardgame:master-SNAPSHOT'
+	}
+```
+If you use the html module, you have to add also this module to its dependencies:
+```groovy
+	dependencies {
+			implementation 'com.github.jeremyz:gdx-boardgame:master-SNAPSHOT:sources'
+	}
+```
+
+For the html build, you have to add this line to your *.gwt.xml files in the html project:
+```xml
+<inherits name='ch.asynk.gdx.boardgame'/>
+```
+
+## javadoc
+
+[Latest](https://javadoc.jitpack.io/com/github/jeremyz/gdx-boardgame/master-SNAPSHOT/javadoc/)