asciidoc documentation v0.4 and publishing

docs/partnerapi.adoc

@@ -68,11 +68,11 @@ Most of the following sections have been generated with  https://spring.io/proje
 A `GET` request is used to access all the partners read.
 
 ==== Request structure
-include::./getAllPartners/http-request.adoc[]
+include::getAllPartners/http-request.adoc[]
 
 
 ==== Example response
-include::./getAllPartners/http-response.adoc[]
+include::getAllPartners/http-response.adoc[]
 
 NOTE: response body within content json array and pagination infos within pageable json object
 
@@ -205,13 +205,13 @@ NOTE: Here the locale should be en_BE
 A `PUT` request is used to update a partner resource.
 
 ==== Request structure
-include::./updatePartner/http-request.adoc[]
+include::updatePartner/http-request.adoc[]
 
 ==== Example response
-include::./updatePartner/http-response.adoc[]
+include::updatePartner/http-response.adoc[]
 
 ==== CURL request
-include::./updatePartner/curl-request.adoc[]
+include::updatePartner/curl-request.adoc[]
 
 ==== Example PUT request with errors
 The errors for validating locale and date are the same between PUT and POST
@@ -264,16 +264,16 @@ Response
 A `DELETE` request is used to delete the partner.
 
 ==== Request structure
-include::./deletePartner/http-request.adoc[]
+include::deletePartner/http-request.adoc[]
 
 ==== Path Parameters
-include::./deletePartner/path-parameters.adoc[]
+include::deletePartner/path-parameters.adoc[]
 
 ==== Example response
-include::./deletePartner/http-response.adoc[]
+include::deletePartner/http-response.adoc[]
 
 ==== CURL request
-include::./deletePartner/curl-request.adoc[]
+include::deletePartner/curl-request.adoc[]
 
 ==== Example DELETE request with errors
 ===== Example with error on update with with partner not found
@@ -291,7 +291,7 @@ Response
 ----
 
 
-== Usefull commands
+== Useful commands
 _Assuming you are using a bash cli_
 
 === Run the app in dev env

readme.md

@@ -0,0 +1,41 @@
+# Api partner for B2Boost 🚀
+
+Doc Writer [art-dambrine.ovh](https://art-dambrine.ovh) [@art-dambrine]
+
+
+
+### Framework and build tools
+
+For this project I chose to use Spring Boot alongside Gradle.
+
+
+
+### Api documentation
+
+In the following document you will find a simple documentation of the API. Most of the following sections have been generated with  [Spring Rest Docs](https://spring.io/projects/spring-restdocs).
+
+You will find the documentation in the **docs.html** at the root of this project, it's also available here 👉 [API DOCUMENTATION](https://art-dambrine.ovh/asciidoc/docs/api-partner-for-b2boost.html)
+
+
+
+### Useful commands
+
+*Assuming you are using a bash cli*
+
+### Run the app in dev env
+
+```
+./gradlew bootRun
+```
+
+### Run the test suite with gradle
+
+```
+./gradlew test
+```
+
+### Prepare the jar archive with gradle for deployment
+
+```
+./gradlew clean bootJar
+```