From 59d9a2d1b71887eb1024259a71ccc02b271f152b Mon Sep 17 00:00:00 2001
From: Renaldas Szentiks <renaldas.szentiks@infocentric.ch>
Date: Mon, 27 Nov 2023 11:22:48 +0100
Subject: [PATCH] Adjust readme with installation instructions

---
 README.md | 44 +++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 43 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e85f3bf..c1f829c 100644
--- a/README.md
+++ b/README.md
@@ -156,6 +156,48 @@ test, execute:
 
     mvn clean test
     
+### Embedding Into Existing Projects
+
+You can embed this tool into other projects by creating a local maven repo in your project by adding the following 
+repo definition in your main POM:
+
+    <repositories>
+        <repository>
+            <id>local-repo</id>
+            <url>file:nonadobedependencies</url>
+            <name>Repository</name>
+            <releases>
+                <enabled>true</enabled>
+                <updatePolicy>never</updatePolicy>
+            </releases>
+            <snapshots>
+                <enabled>false</enabled>
+            </snapshots>
+        </repository>
+    </repositories> 
+    
+Afterwards, download the desired release package and execute the following command:
+
+    mvn install:install-file -Dfile={downloaded package file} -DgroupId=com.valtech.aem -DartifactId=msm-tools.all -Dversion={version} -Dpackaging=zip -DlocalRepositoryPath=./nonadobedependencies
+
+The last step is to include the package as a dependency in your `all` package, by using the dependency definition:
+
+    <dependency>
+      <groupId>com.valtech.aem</groupId>
+      <artifactId>msm-tools.all</artifactId>
+      <version>{version}</version>
+      <type>zip</type>
+    </dependency>
+
+And including into the `embeddeds` definition of your `filevault-package-maven-plugin`:
+    
+    <ebedded>
+      <groupId>com.valtech.aem</groupId>
+      <artifactId>msm-tools.all</artifactId>
+      <type>zip</type>
+      <target>{location of your other vendor packages under /apps}</target>
+    </ebedded>
+
 ## License
 
-The SaaS AEM module is licensed under the [MIT LICENSE](LICENSE).
\ No newline at end of file
+The AEM MSM Tools module is licensed under the [MIT LICENSE](LICENSE).
\ No newline at end of file