diff --git a/README.md b/README.md
index 5bca536..785b99c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,34 @@
-# keycloak-extensions
-Extensions for Keycloak
+# Extensions for Keycloak
+
+This project contains multiple custom extensions that we use in our Keycloak deployment.
+
+### Packaging artifacts
+
+Artifacts are packaged using maven. If an extensions depends on a library that's not provided by keycloak it should be deployed as an ear.
+To build all artifacts use the following command:
+```
+./mvnw clean compile package
+```
+
+### Releasing to github
+
+Create a maven settings file in `~/.m2/settings.xml` with the following contents and fill in your username and api token:
+```
+
+ ${user.home}/.m2/repository
+
+
+
+ github
+ GITHUB_USERNAME
+ GITHUB_API_TOKEN
+
+
+
+```
+
+To create a github release and upload the generated artifacts on github use the following command:
+```
+./mvnw -pl . de.jutzig:github-release-plugin:1.1.1:release
+```
diff --git a/admin/pom.xml b/admin/pom.xml
index 8fa98be..3f9e348 100644
--- a/admin/pom.xml
+++ b/admin/pom.xml
@@ -5,7 +5,6 @@
4.0.0
admin
- ${extensions-version}
jar
Keycloak Extensions - Admin API
Administrative endpoints
diff --git a/jmx-metrics/pom.xml b/jmx-metrics/pom.xml
index fca2104..4fa915f 100644
--- a/jmx-metrics/pom.xml
+++ b/jmx-metrics/pom.xml
@@ -5,7 +5,6 @@
4.0.0
jmx-metrics
- ${extensions-version}
jar
Keycloak Extensions - Jmx Metrics (jar)
diff --git a/pom.xml b/pom.xml
index eb9c433..e50183b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -4,6 +4,12 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
4.0.0
+
+ https://github.com/tidepool-org/keycloak-extensions
+ scm:git:https://github.com/tidepool-org/keycloak-extensions.git
+ scm:git:git@github.com:tidepool-org/keycloak-extensions.git
+
+
org.tidepool.keycloak
keycloak-extensions
${extensions-version}
@@ -11,7 +17,7 @@
Keycloak Extensions
- 0.0.3-SNAPSHOT
+ 0.0.5-SNAPHOT
@@ -19,4 +25,31 @@
jmx-metrics
jmx-metrics-ear
+
+
+
+
+ de.jutzig
+ github-release-plugin
+ 1.1.1
+ false
+
+
+ tidepool-org/keycloak-extensions
+ ${project.version}
+ ${project.version}
+
+
+
+ ${project.basedir}
+
+ admin/target/*-${extensions-version}.jar
+ jmx-metrics-ear/target/*-${extensions-version}.ear
+
+
+
+
+
+
+