From e5f8dd4cdf5f1603b3119cd5d07615ecae3392e6 Mon Sep 17 00:00:00 2001
From: Mathieu POUSSE <mathieu.pousse@ouest-france.fr>
Date: Mon, 22 Nov 2021 11:23:59 +0100
Subject: [PATCH] chore: prepare next version, and adjust the documentation

---
 README.md => README.adoc | 30 ++++++++++++++++++------------
 pom.xml                  |  2 +-
 2 files changed, 19 insertions(+), 13 deletions(-)
 rename README.md => README.adoc (66%)

diff --git a/README.md b/README.adoc
similarity index 66%
rename from README.md
rename to README.adoc
index 8bf796e..20e7e8c 100644
--- a/README.md
+++ b/README.adoc
@@ -1,33 +1,38 @@
-# bp-contract-generator-java
+= bp-contract-generator-java
+:tip-caption: :bulb:
 
-Here is an easy and programmatic way to generate block provider contracts. Contracts are valid by design and will fit
-perfectly with the BMS.
+We are aware that writing a block provider contract is clearly a pain in the ass.
+Therefore, to limit this frustration, and to let you focus on your business, we offer you a simple fluid API to help you.
 
-This fluid API helps you to declare multiple block types with theirs endpoint, parameters and associated templates.
+This is an easy and programmatic way to generate block provider contracts.
+Contracts are valid by design and will fit perfectly with the BMS.
+
+This API helps you to declare multiple block types with theirs endpoint, parameters and associated templates.
 
 You simply need to generate the object and let your favorite JSON framework serialize it.
 
-## How to install
+== How to install
 
 ```xml
 
-<dependecy>
+<dependency>
     <groupId>io.github.ouest-france</groupId>
     <artifactId>bp-contract-generator</artifactId>
     <version>1.0.0</version>
-</dependecy>
+</dependency>
 ```
 
-## Demonstration
+NOTE: the lib require Java 8 and does not provide any serialization tool
 
-Here is an example with a block type that takes an input text, sends it to a remote service (for demonstration only),
-and outputs the bolded text with different templates.
+== Getting started
 
-```java
+Here is an example with a block type that takes an input text, sends it to a remote service (for demonstration only), and outputs the bolded text with different templates.
 
+The following example assumes Spring is available on project, and Jackson has been properly configured.
+
+```java
 @RequestMapping("/block-provider")
 @RestController
-@RequiredArgsConstructor
 public class BlockProviderResource {
 
     @GetMapping("/configurations")
@@ -69,3 +74,4 @@ public class BlockProviderResource {
 }
 ```
 
+You might find many other exampls in the test directory link:src/test/java/sipa/blockprovider/examples/
diff --git a/pom.xml b/pom.xml
index 94f5b2e..0b04d55 100644
--- a/pom.xml
+++ b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>io.github.ouest-france</groupId>
     <artifactId>bp-contract-generator</artifactId>
-    <version>1.0.0</version>
+    <version>1.0.1-SANPASHOT</version>
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>