diff --git a/README.md b/README.md index d0bb2c93..78e12955 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,41 @@ # Posten Signering – Java client Library [![Maven Central](https://maven-badges.herokuapp.com/maven-central/no.digipost.signature/signature-api-client-java/badge.svg)](https://maven-badges.herokuapp.com/maven-central/no.digipost.signature/signature-api-client-java) +[![javadoc](https://javadoc.io/badge2/no.digipost.signature/signature-api-client-java/javadoc.svg?logo=java&color=yellow)](https://javadoc.io/doc/no.digipost.signature/signature-api-client-java) ![](https://github.com/digipost/signature-api-client-java/workflows/Build%20and%20deploy/badge.svg) [![License](https://img.shields.io/badge/license-Apache%202-blue)](https://github.com/digipost/signature-api-client-java/blob/main/LICENCE) -This repo is the Java client library for integrating with Posten signering. Please see [signature-api-client-dotnet](https://github.com/digipost/signature-api-client-dotnet) for the C# version. +This repo is the Java client library for integrating with **Posten signering**. -## 📕 Documentation +If you are looking for the C# variant of this library, please see [signature-api-client-dotnet](https://github.com/digipost/signature-api-client-dotnet). + +## Documentation Get started by [reading the documentation](http://signering-docs.rtfd.io/). - -## Releasing (only for Digipost members) -See docs/systemer/open-source-biblioteker.md + +## Dependency + +The recommended way to declare dependency on the library is to utilize the [BOM](https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#bill-of-materials-bom-poms). With Maven, this is declared like this: + +```xml + + + + no.digipost.signature + signature-api-client-bom + 7.0.1 + pom + import + +... +``` + +And depend directly on the library artifact (without any specified version, since this is supplied by the BOM artifact above) +```xml + + + no.digipost.signature + signature-api-client-java + +... +``` diff --git a/lib/pom.xml b/lib/pom.xml index 863fbefc..feadfb90 100644 --- a/lib/pom.xml +++ b/lib/pom.xml @@ -188,7 +188,7 @@ com.github.siom79.japicmp japicmp-maven-plugin - 0.17.3 + 0.18.1 @@ -202,7 +202,7 @@ maven-shade-plugin - 3.5.0 + 3.5.1 true @@ -236,7 +236,7 @@ maven-javadoc-plugin - 3.5.0 + 3.6.0 maven-jar-plugin diff --git a/pom.xml b/pom.xml index 84646d05..eea5558e 100644 --- a/pom.xml +++ b/pom.xml @@ -77,7 +77,7 @@ org.codehaus.mojo versions-maven-plugin - 2.16.0 + 2.16.1