feat: added comments and readme

pom.xml

@@ -3,7 +3,7 @@
   <modelVersion>4.0.0</modelVersion>
   <scm>
     <connection>scm:git:ssh://gitea@gitea.rickrongen.nl:8789/RickRongen/tmp-sbcommon.git</connection>
-    <url>ssh://gitea@gitea.rickrongen.nl:8789/RickRongen/tmp-sbcommon.git</url>
+    <url>https://gitea.rickrongen.nl/RickRongen/tmp-sbcommon</url>
     <tag>HEAD</tag>
   </scm>
 
@@ -23,6 +23,10 @@
   </modules>
 
   <properties>
+    <!--
+    These properties are shared within this repository, but they are NOT used by the spring-boot-parent module
+    Any consumers of the parent module thus don't get these properties.
+    -->
     <maven.compiler.source>17</maven.compiler.source>
     <maven.compiler.target>17</maven.compiler.target>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -36,10 +40,10 @@
         <configuration>
           <autoVersionSubmodules>true</autoVersionSubmodules>
           <projectVersionPolicyId>SemVerVersionPolicy</projectVersionPolicyId>
+          <!--NOTE: below uses an `@`, which is parsed by the release plugin instead-->
           <tagNameFormat>v@{project.version}</tagNameFormat>
         </configuration>
       </plugin>
-
     </plugins>
   </build>