From 980f8d90c7d6ee7e9f2f2bed8dabde6cad26353c Mon Sep 17 00:00:00 2001
From: Joern Muehlencord <joern.muehlencord@vitroconnect.com>
Date: Sat, 26 Aug 2023 13:24:38 +0200
Subject: [PATCH] updated documentation

---
 README.md     | 41 ++++++++++++++++++++++++++++++++++++++---
 copyright.txt |  4 ++++
 pom.xml       |  4 ++--
 3 files changed, 44 insertions(+), 5 deletions(-)
 create mode 100644 copyright.txt

diff --git a/README.md b/README.md
index aa524df..a262d66 100644
--- a/README.md
+++ b/README.md
@@ -2,13 +2,34 @@
 
 Additional DefaultAccessorNamingStrategy to support fluent API withXYZ setters.
 
+[![License](https://img.shields.io/badge/License-Apache%202.0-yellowgreen.svg)](https://github.com/mapstruct/mapstruct/blob/master/LICENSE.txt)
+
+[![Build Status](https://github.com/mapstruct/mapstruct-idea/workflows/CI/badge.svg?branch=master)](https://github.com/mapstruct/mapstruct-idea/actions?query=workflow%3ACI+branch%3Amaster)
+[![Coverage Status](https://codecov.io/gh/mapstruct/mapstruct-idea/branch/master/graph/badge.svg)](https://codecov.io/gh/mapstruct/mapstruct-idea)
+
+* [What is MapStruct?](#what-is-mapstruct)
+* [Features](#features)
+* [Usage](#usage)
+* [Example](#example)
+* [Requirements](#requirements)
+* [Building from Source](#building-from-source)
+* [Licensing](#licensing)
+
+## What is MapStruct?
+
+MapStruct is a Java [annotation processor](https://docs.oracle.com/javase/6/docs/technotes/guides/apt/index.html) for the generation of type-safe and performant mappers for Java bean classes.
+
+To learn more about MapStruct have a look at the [mapstruct](https://github.com/mapstruct/mapstruct) repository or the [website](https://mapstruct.org/)
+
+## Features
+
 Mapstruct default naming strategy detects the methods `withFirstName` and `withLastName` (see example below) as extra
 target fields and therefore cause an error, when the mapper is annotated with
 `unmappedTargetPolicy = ReportingPolicy.ERROR`.
 
 The additional naming strategy makes Mapstruct ignore the withXYZ setters. 
 
-## Installation
+## Usage
 
 To use the extended naming strategy, just include it as project dependency alongside with mapstruct.
 
@@ -18,12 +39,12 @@ To use the extended naming strategy, just include it as project dependency along
   <dependency>
     <groupId>org.mapstruct</groupId>
     <artifactId>mapstruct</artifactId>
-    <version>1.4.2.Final</version>
+    <version>1.5.5.Final</version>
   </dependency>
   <dependency>
     <groupId>de.muehlencord.mapstruct</groupId>
     <artifactId>mapstruct-support</artifactId>
-    <version>1.4.2</version>
+    <version>1.5.5</version>
   </dependency>
 </dependencies>
 ```
@@ -71,3 +92,17 @@ public class Person {
 
 ```
 
+## Requirements
+
+The MapStruct plugin requires Java 11 or later
+
+## Building from Source
+mapstruct-support uses maven as build system. Simple execute
+
+```shell
+ mvn clean install
+```
+
+## Licensing
+
+The MapStruct plugin is licensed under the Apache License, Version 2.0 (the "License"); you may not use it except in compliance with the License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0.
diff --git a/copyright.txt b/copyright.txt
new file mode 100644
index 0000000..dfdbff7
--- /dev/null
+++ b/copyright.txt
@@ -0,0 +1,4 @@
+Contributors
+============
+
+Joern Muehlencord - https://github.com/jomu78
diff --git a/pom.xml b/pom.xml
index 19ffbad..6b6f9a6 100644
--- a/pom.xml
+++ b/pom.xml
@@ -67,9 +67,9 @@
   <build>
     <plugins>
       <plugin>
-        <artifactId>maven-release-plugin</artifactId>
         <groupId>org.apache.maven.plugins</groupId>
-        <version>3.0.0-M6</version>
+        <artifactId>maven-release-plugin</artifactId>
+        <version>3.0.1</version>
       </plugin>
     </plugins>
   </build>