add more documentation

eitco · May 23, 2024 · f2e30c8 · f2e30c8
1 parent c2a3fbc
commit f2e30c8
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -8,6 +8,34 @@
 This goal scans the current project and creates a bill of materials (bom) pom containing the current project 
 and all of its (sub-) modules with the current version as dependency management.
 
+activate it in the following way:
+
+```xml
+<project>
+    ...
+    <build>
+        ...
+        <plugins>
+            ...
+            <plugin>
+                <groupId>de.eitco.cicd</groupId>
+                <artifactId>bom-maven-plugin</artifactId>
+                <version>5.0.0</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>create</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+</project>
+```
+Check for the latest version [here](https://central.sonatype.com/artifact/de.eitco.cicd/bom-maven-plugin). This enables the following goals:
+
+
 It can be customized with the following parameters:
 
 ## additionalBoms

diff --git a/src/it/modules/pom.xml b/src/it/modules/pom.xml
@@ -88,16 +88,8 @@
                     <execution>
                         <goals>
                             <goal>create</goal>
-                            <goal>install</goal>
                         </goals>
                     </execution>
-                    <execution>
-                        <id>deploy</id>
-                        <goals>
-                            <goal>deploy</goal>
-                        </goals>
-                        <phase>install</phase>
-                    </execution>
                 </executions>
             </plugin>
         </plugins>