diff --git a/README.md b/README.md index 4730a67..f5c3266 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,24 @@ A simple Java client for ACINQ's [phoenixd REST API](https://phoenix.acinq.co/server/api). It wraps the HTTP endpoints and exposes typed requests and responses. +## Installation +Artifacts are published to a Reposilite server. Add the repository to your Maven configuration to resolve the artifacts: + +```xml + + + reposilite-releases + https://maven.398ja.xyz/releases + + + + + xyz.tcheeric + phoenixd-rest + 1.0-SNAPSHOT + +``` + ## Requirements - Java 21 - Maven diff --git a/docs/how-to/release.md b/docs/how-to/release.md index 49eda7a..14ff50b 100644 --- a/docs/how-to/release.md +++ b/docs/how-to/release.md @@ -1,3 +1,27 @@ # Release -Tag a commit with `v*` to trigger the release workflow. The workflow builds the JARs with `mvn -q package`, publishes them to GitHub Packages, and pushes a Docker image built from `phoenixd-rest/Dockerfile` to the GitHub Container Registry. +Tag a commit with `v*` to trigger the release workflow. The workflow builds the JARs with `mvn -q package`, publishes them to the Reposilite server, and pushes a Docker image built from `phoenixd-rest/Dockerfile` to the GitHub Container Registry. + +Artifacts are published using the Reposilite repository. The parent `pom.xml` defines the distribution and resolution repositories: + +```xml + + + reposilite-releases + https://maven.398ja.xyz/releases + + + reposilite-snapshots + https://maven.398ja.xyz/snapshots + + + + + + reposilite-releases + https://maven.398ja.xyz/releases + + +``` + +Ensure your `~/.m2/settings.xml` includes credentials for the `reposilite-releases` and `reposilite-snapshots` servers before tagging a release. diff --git a/pom.xml b/pom.xml index ef27339..d939ded 100644 --- a/pom.xml +++ b/pom.xml @@ -67,6 +67,24 @@ + + + reposilite-releases + https://maven.398ja.xyz/releases + + + reposilite-snapshots + https://maven.398ja.xyz/snapshots + + + + + + reposilite-releases + https://maven.398ja.xyz/releases + + +