From 36a2a56f2882024425ba4eb87991ee8606997680 Mon Sep 17 00:00:00 2001
From: samo_lego <34912839+samolego@users.noreply.github.com>
Date: Thu, 2 Jul 2020 10:31:19 +0200
Subject: [PATCH] Update README.md

---
 README.md | 65 +++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 51 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 732e7d4..9b02faa 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,13 @@
 # Simple Authentication Mod
 
-![License](https://img.shields.io/github/license/samolego/simpleauth.svg)
-![Gradle Build](https://github.com/samolego/SimpleAuth/workflows/Gradle%20Build/badge.svg)
-![Version](https://img.shields.io/github/v/tag/samolego/SimpleAuth.svg?label=version)
-![Issues](https://img.shields.io/github/issues/samolego/simpleauth.svg)
+[![License](https://img.shields.io/github/license/samolego/simpleauth.svg)](https://github.com/samolego/SimpleAuth/blob/master/LICENSE)
+[![Gradle Build](https://github.com/samolego/SimpleAuth/workflows/Gradle%20Build/badge.svg)](https://samolego.github.io/projects/ci/SimpleAuth/latest)
+[![Version](https://img.shields.io/github/v/tag/samolego/SimpleAuth.svg?label=version)](https://github.com/samolego/SimpleAuth/releases/latest)
+[![Closed Issues](https://img.shields.io/github/issues-closed/samolego/simpleauth.svg)](https://github.com/samolego/SimpleAuth/issues?q=is%3Aissue+is%3Aclosed)
 [![Curseforge downloads](http://cf.way2muchnoise.eu/full_simpleauth_downloads.svg)](https://www.curseforge.com/minecraft/mc-mods/simpleauth)
 
 Requires Fabric API.
 
-## Setup
-
-1. Clone the repository. Then run `./gradlew genSources`
-2. Edit the code you want.
-3. To build run the following command:
-
-```
-./gradlew build
-```
-
 ## License
 Libraries that the project is using:
 - `Argon2 (LGPLv3)` https://github.com/phxql/argon2-jvm
@@ -25,3 +15,50 @@ Libraries that the project is using:
 - `JNA (Apache 2 || LGPLv3)` https://github.com/java-native-access/jna
 
 This project is licensed under the `MIT` license.
+
+# For mod developers
+
+## Changing code
+
+1. Clone the repository. Then run `./gradlew genSources`
+2. Edit the code you want.
+3. To build run the following command:
+
+```
+./gradlew build
+```
+## Adding the mod to your buildscript (to ensure compatibility)
+
+Add following text to your `build.gradle`
+
+```gradle
+repositories {
+	maven {
+		url 'https://jitpack.io'
+	}
+}
+
+dependencies {
+  // By version tag
+  modImplementation 'com.github.samolego:SimpleAuth:${project.simpleauth_version}'
+  
+  // Or by branch
+  modImplementation 'com.github.samolego:SimpleAuth:${project.simpleauth_branch}-SNAPSHOT'
+}
+```
+
+And this to your `gradle.properties`
+```gradle
+# By tag (version)
+# SimpleAuth version (this might not be the latest version)
+simpleauth_version = 1.4.6
+
+# Or this (by branch)
+# SimpleAuth branches
+
+# master branch (the latest version for stable minecraft release)
+simpleauth_branch = master
+
+# snapshot branch (branch for minecraft snapshots)
+simpleauth_branch = latest-snapshot
+```