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: + + + + local-repo + file:nonadobedependencies + Repository + + true + never + + + false + + + + +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: + + + com.valtech.aem + msm-tools.all + {version} + zip + + +And including into the `embeddeds` definition of your `filevault-package-maven-plugin`: + + + com.valtech.aem + msm-tools.all + zip + {location of your other vendor packages under /apps} + + ## 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