Remove demo + Add docs

Author: AB-xdev

.github/workflows/check-build.yml

@@ -19,9 +19,6 @@ on:
       - '.idea/**'
       - 'assets/**'
 
-env:
-  DEMO_MAVEN_MODULE: ${{ github.event.repository.name }}-demo
-
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -68,13 +65,6 @@ jobs:
           exit 1
         fi
 
-    - name: Upload demo files
-      uses: actions/upload-artifact@v5
-      with:
-        name: demo-files-java-${{ matrix.java }}
-        path: ${{ env.DEMO_MAVEN_MODULE }}/target/${{ env.DEMO_MAVEN_MODULE }}.jar
-        if-no-files-found: error
-
   checkstyle:
     runs-on: ubuntu-latest
     if: ${{ github.event_name != 'pull_request' || !startsWith(github.head_ref, 'renovate/') }}

.run/Run Demo.run.xml

@@ -1,16 +1,18 @@
 [![Latest version](https://img.shields.io/maven-central/v/software.xdev/mailpit-java-client?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/mailpit-java-client)
 [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/mailpit-java-client/check-build.yml?branch=develop)](https://github.com/xdev-software/mailpit-java-client/actions/workflows/check-build.yml?query=branch%3Adevelop)
 
-# mailpit-java-client
+# Java Client for [Mailpit](https://github.com/axllent/mailpit)
+
+A Java client for [Mailpit's API](https://mailpit.axllent.org/docs/api-v1/).
 
 This client [is generated](./mailpit-java-client/pom.xml) from an [``swagger.json``](./openapi/swagger.json) using [OpenAPI Generator](https://openapi-generator.tech/).
 
+## Usage
+You can find out how the generated API might be used by having a look at [the tests](./mailpit-java-client/src/test/java/software/xdev/mailpit/).
+
 ## Installation
 [Installation guide for the latest release](https://github.com/xdev-software/mailpit-java-client/releases/latest#Installation)
 
-## Demo
-A minimal demo is also available [here](./mailpit-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).
 

README.md

@@ -16,7 +16,6 @@
 
 	<modules>
 		<module>mailpit-java-client</module>
-		<module>mailpit-java-client-demo</module>
 	</modules>
 
 	<properties>