Update docs

Author: AB-xdev

CHANGELOG.md

@@ -0,0 +1,7 @@
+# 1.0.0 
+
+* Initial release
+* Supports Sessionize API ``v2`` and the following endpoints
+  * ``/view/All``
+  * ``/view/Speakers``
+  * ``/view/Sessions``

README.md

@@ -2,12 +2,21 @@
 [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/sessionize-java-client/checkBuild.yml?branch=develop)](https://github.com/xdev-software/sessionize-java-client/actions/workflows/checkBuild.yml?query=branch%3Adevelop)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_sessionize-java-client&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_sessionize-java-client)
 
-# [sessionize](https://sessionize.com/)-java-client
+# <img src="https://sessionize.com/landing/images/brand/logo/sessionize-avatar.svg" height="22" /> [sessionize](https://sessionize.com/)-java-client
 A Java client for the [Sessionize API](https://sessionize.com/playbook/api)
 
+This client [is generated](./sessionize-java-client/pom.xml) from an [``openapi.yml``](./openapi/openapi.yml) using [OpenAPI Generator](https://openapi-generator.tech/).
+
+Currently this client supports Sessionize API ``v2`` and the following endpoints
+  * ``/view/All``
+  * ``/view/Speakers``
+  * ``/view/Sessions``
+
 ## Installation
 [Installation guide for the latest release](https://github.com/xdev-software/sessionize-java-client/releases/latest#Installation)
 
+## Demo
+A minimal demo is also available [here](./sessionize-java-client-demo/src/main/java/software/xdev/Application.java).
 
 ## Support
 If you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).

openapi/INFO.md

@@ -0,0 +1,7 @@
+This ``openapi.yml`` was written manually as sessionize fails to provide an API schema or something similar.
+
+The Java API Client can be generated using ``mvn clean compile -P openapi-generator`` inside [``sessionize-java-client``](../sessionize-java-client/).
+
+Helpful links:
+* https://jsonformatter.org/json-to-jsonschema
+* https://swagger.io/specification/

sessionize-java-client/pom.xml

@@ -47,6 +47,11 @@
 
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+
+		<!-- Ignore generated code -->
+		<sonar.exclusions>
+			src/generated/**
+		</sonar.exclusions>
 	</properties>
 
 	<repositories>