README.md updates

Author: jann0k

.github/workflows/maven-publish.yml

@@ -1,7 +1,7 @@
 # This workflow will build a package using Maven and then publish it to GitHub packages when a release is created
 # For more information see: https://github.com/actions/setup-java/blob/main/docs/advanced-usage.md#apache-maven-with-a-settings-path
 
-name: Maven Package
+name: Publish OpenAPI specification yaml files
 
 on:
   release:

README.md

@@ -1,12 +1,14 @@
 # CDOC2 OpenAPI
 
-Contains OpenAPI specifications.
+Contains OpenAPI specifications for [CDOC2 project](https://open-eid.github.io/CDOC2)
 
 ## Java
 
-Openapi specification maven artifacts can be installed (local `~/.m2` directory) or deployed 
+Openapi specification maven artifacts (`packaging=yaml`) can be installed (local `~/.m2` directory) or deployed 
 (remote maven package repository) with standard `mvn install` or `mvn deploy` commands. 
 
+`mvn install` will parse `info.version` from `*-openapi.yaml` and use that as maven package version. 
+
 ### Get from GitHub package repo
 
 Configure github package repo access 
@@ -34,7 +36,17 @@ can be found in maven package repository:
 
 https://github.com/open-eid/cdoc2-openapi/packages
 
-## Releasing/Publishing OpenApi specification
+## Releasing/Publishing OpenApi using GitHub actions
+
+Push a new version of *-openapi.yaml to GitHub.  
+
+Create GitHub Release
+https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release
+
+That will trigger `.github/workflows/maven-publish.yml` that will call `mvn deploy` with correct parameters
+
+
+## Releasing/Publishing OpenApi specification manually
 
 Deploy/publish OpenApi manually:
 `mvn -Dproject.distributionManagement.repository.id=github -Dproject.distributionManagement.repository.url=https://maven.pkg.github.com/open-eid/cdoc2-openapi deploy`
@@ -56,6 +68,16 @@ mvn deploy:deploy-file \
 ```
 Refer: https://maven.apache.org/plugins/maven-deploy-plugin/deploy-file-mojo.html
 
+## Delete OpenApi package from local Maven repository
+```
+mvn dependency:purge-local-repository -DmanualInclude=ee.cyber.cdoc2.openapi:cdoc2-key-capsules-openapi
+```
+
+## Usage from Java Maven projects for code generation
+
+See:
+* https://github.com/open-eid/cdoc2-java-ref-impl/blob/master/cdoc2-client/pom.xml
+* https://github.com/open-eid/cdoc2-capsule-server/blob/master/cdoc2-server-openapi/pom.xml