Updated README files

egoettelmann · Sep 6, 2022 · a381515 · a381515
1 parent 64c7634
commit a381515
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 11 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -46,7 +46,6 @@ jobs:
             OLD_PROJECT_VERSION=$(mvn help:evaluate -N -Dexpression=project.version|grep -v '\[')
             mvn versions:set -DremoveSnapshot=true -DgenerateBackupPoms=false
             PROJECT_VERSION=$(mvn help:evaluate -N -Dexpression=project.version|grep -v '\[')
-            sed -i "s,<version>$OLD_PROJECT_VERSION</version>,<version>$PROJECT_VERSION</version>,g" README.md
             find ./ -iname "README.md" -exec sed -i "s,<version>$OLD_PROJECT_VERSION</version>,<version>$PROJECT_VERSION</version>,g" "{}" ";"
             git config user.name "<< pipeline.parameters.git-user >>"
             git config user.email "<< pipeline.parameters.git-email >>"

diff --git a/spring-configuration-aggregator-maven-plugin/README.md b/spring-configuration-aggregator-maven-plugin/README.md
@@ -1,7 +1,8 @@
-Spring Configuration Aggregator Maven Plugin
+Spring Configuration Extensions: Aggregator Maven Plugin
 ==========
 
 [![Maven Central](https://img.shields.io/maven-central/v/com.github.egoettelmann/spring-configuration-aggregator-maven-plugin?style=flat-square&label=Maven%20Central)](https://search.maven.org/artifact/com.github.egoettelmann/spring-configuration-aggregator-maven-plugin)
+[![CircleCI build (develop)](https://img.shields.io/circleci/build/github/egoettelmann/spring-configuration-extensions/develop?label=Develop&style=flat-square)](https://app.circleci.com/pipelines/github/egoettelmann/spring-configuration-extensions?branch=develop)
 
 Maven plugin that aggregates all Spring configuration metadata
 files of the project dependencies into a single one.
@@ -42,7 +43,7 @@ You can simply add the project to the build plugin section.
 <plugin>
     <groupId>com.github.egoettelmann</groupId>
     <artifactId>spring-configuration-aggregator-maven-plugin</artifactId>
-    <version>0.0.7</version>
+    <version>0.0.8-SNAPSHOT</version>
     <executions>
         <execution>
             <goals>
@@ -136,7 +137,7 @@ Simple aggregation, with following additional options:
 <plugin>
     <groupId>com.github.egoettelmann</groupId>
     <artifactId>spring-configuration-aggregator-maven-plugin</artifactId>
-    <version>0.0.7</version>
+    <version>0.0.8-SNAPSHOT</version>
     <configuration>
         <!-- Ignores errors -->
         <failOnError>false</failOnError>
@@ -171,7 +172,7 @@ Simple aggregation, by only including properties from:
 <plugin>
     <groupId>com.github.egoettelmann</groupId>
     <artifactId>spring-configuration-aggregator-maven-plugin</artifactId>
-    <version>0.0.7</version>
+    <version>0.0.8-SNAPSHOT</version>
     <configuration>
         <includeDependencies>
             <!-- Includes only metadata defined in dependencies with same 'groupId' as current project -->
@@ -198,7 +199,7 @@ Aggregation and reporting of all configuration properties.
 <plugin>
     <groupId>com.github.egoettelmann</groupId>
     <artifactId>spring-configuration-aggregator-maven-plugin</artifactId>
-    <version>0.0.7</version>
+    <version>0.0.8-SNAPSHOT</version>
     <configuration>
         <outputReports>
             <!-- Generating default JSON report -->
@@ -237,7 +238,7 @@ Simple aggregation, that declares custom configuration files to load default val
 <plugin>
     <groupId>com.github.egoettelmann</groupId>
     <artifactId>spring-configuration-aggregator-maven-plugin</artifactId>
-    <version>0.0.7</version>
+    <version>0.0.8-SNAPSHOT</version>
     <configuration>
         <!-- Loading default values from custom configuration file -->        
         <propertiesFiles>

diff --git a/spring-configuration-extensions-samples/README.md b/spring-configuration-extensions-samples/README.md
@@ -0,0 +1,9 @@
+Spring Configuration Extensions: Samples
+==========
+
+This module provides a sample configuration for using:
+ - [spring-value-annotation-processor](../spring-value-annotation-processor)
+ - [spring-configuration-aggregator-maven-plugin](../spring-configuration-aggregator-maven-plugin)
+
+Checkout the [pom.xml](pom.xml) file to see a sample usage.
+
diff --git a/spring-value-annotation-processor/README.md b/spring-value-annotation-processor/README.md
@@ -1,7 +1,8 @@
-Spring Value Annotation Processor
+Spring Configuration Extensions: Value Annotation Processor
 ==========
 
 [![Maven Central](https://img.shields.io/maven-central/v/com.github.egoettelmann/spring-value-annotation-processor?style=flat-square&label=Maven%20Central)](https://search.maven.org/artifact/com.github.egoettelmann/spring-value-annotation-processor)
+[![CircleCI build (develop)](https://img.shields.io/circleci/build/github/egoettelmann/spring-configuration-extensions/develop?label=Develop&style=flat-square)](https://app.circleci.com/pipelines/github/egoettelmann/spring-configuration-extensions?branch=develop)
 
 An annotation processor to extract all configuration properties injected through Spring `@Value` annotations.
 
@@ -15,7 +16,7 @@ If using Maven, you can simply add the project as a `provided` dependency.
 <dependency>
     <groupId>com.github.egoettelmann</groupId>
     <artifactId>spring-value-annotation-processor</artifactId>
-    <version>0.0.4-SNAPSHOT</version>
+    <version>0.0.8-SNAPSHOT</version>
     <scope>provided</scope>
 </dependency>
 ```
@@ -33,7 +34,7 @@ The plugin's configuration should look to something like the following:
             <annotationProcessorPath>
                 <groupId>com.github.egoettelmann</groupId>
                 <artifactId>spring-value-annotation-processor</artifactId>
-                <version>0.0.4-SNAPSHOT</version>
+                <version>0.0.8-SNAPSHOT</version>
             </annotationProcessorPath>
         </annotationProcessorPaths>
     </configuration>
@@ -60,7 +61,7 @@ Configuration would be as follows:
             <annotationProcessorPath>
                 <groupId>com.github.egoettelmann</groupId>
                 <artifactId>spring-value-annotation-processor</artifactId>
-                <version>0.0.4-SNAPSHOT</version>
+                <version>0.0.8-SNAPSHOT</version>
             </annotationProcessorPath>
         </annotationProcessorPaths>
         <compilerArgs>