From 8116939dfac16b6027d7fea6c355256869e82e10 Mon Sep 17 00:00:00 2001
From: sebthom <sebthom@users.noreply.github.com>
Date: Wed, 14 Aug 2024 23:42:30 +0200
Subject: [PATCH] docs: add info about Maven Snapshots

---
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 43 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 98630673c..4ce16334b 100644
--- a/README.md
+++ b/README.md
@@ -11,18 +11,14 @@ TM4E is an [official Eclipse.org project](https://projects.eclipse.org/projects/
 
 ## 📥 Install
 
-### in Eclipse IDE or RCP applications
+### 1) in Eclipse IDE or RCP applications
 
 You can install TM4E from the update site [https://download.eclipse.org/tm4e/releases/latest/](https://download.eclipse.org/tm4e/releases/latest/).
 TM4E is usually installed together with its consumers, so end-user should usually not need to directly install it.
 
 The latest snapshot build can be installed from the update site [https://download.eclipse.org/tm4e/snapshots/](https://download.eclipse.org/tm4e/snapshots/).
 
-### as a Java API with Maven
-
-[more information coming soon]
-
-### Eclipse IDE compatibility
+#### Eclipse IDE compatibility
 
 TM4E version | Min. Eclipse version
 -------------|--------------------
@@ -35,6 +31,47 @@ TM4E version | Min. Eclipse version
 [0.6.0](https://download.eclipse.org/tm4e/releases/0.6.0/)+  | [2022-03](https://projects.eclipse.org/releases/2022-03) ([4.23](https://projects.eclipse.org/projects/eclipse/releases/4.23.0))
 
 
+### 2) as a Java API with Maven
+
+**Snapshot** binaries of `org.eclipse.tm4e.core` are available via at https://repo.eclipse.org/content/repositories/tm4e-snapshots/org/eclipse/org.eclipse.tm4e.core/.
+You need to add the following repository configuration to your Maven `settings.xml`:
+
+```xml
+<?xml version="1.0" encoding="UTF-8" ?>
+<settings>
+  <profiles>
+    <profile>
+      <repositories>
+        <repository>
+          <id>tm4e-snapshots</id>
+          <name>tm4e-snapshots</name>
+          <url>https://repo.eclipse.org/content/repositories/tm4e-snapshots/</url>
+          <releases><enabled>false</enabled></releases>
+          <snapshots><enabled>true</enabled></snapshots>
+        </repository>
+      </repositories>
+    </profile>
+  </profiles>
+  <activeProfiles>
+    <activeProfile>tm4e-snapshots</activeProfile>
+  </activeProfiles>
+</settings>
+```
+
+Then you can reference the dependency in your pom.xml like so:
+```xml
+<dependencies>
+  <dependency>
+    <groupId>org.eclipse</groupId>
+    <artifactId>org.eclipse.tm4e.core</artifactId>
+    <version>[VERSION]-SNAPSHOT</version>
+  </dependency>
+</dependencies>
+```
+
+[more information coming ...]
+
+
 ## ⌨️ Code
 
 <a href="https://mickaelistria.github.io/redirctToEclipseIDECloneCommand/redirect.html"><img src="https://mickaelistria.github.io/redirctToEclipseIDECloneCommand/cloneToEclipseBadge.png" alt="Clone to Eclipse IDE"/></a>