From 2346ecea700ca0cde07db7d7c26e47e5f4738940 Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Thu, 6 Jul 2023 17:05:48 +0200 Subject: [PATCH] Document using GitPack or GitHub Packages as a source --- README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/README.md b/README.md index 882eab3..0f55234 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,64 @@ A common example is using Wiremock 3.x with Java 1.8. ### Importing the dependency +At the moment the module is published to GitHub Packages only, +see [Issue #56](https://github.com/wiremock/wiremock-testcontainers-java/issues/56) +for publishing to Maven Central. +For the moment, you can use the authenticated GitHub Packages server or +[JitPack](https://jitpack.io/) to add the dependency in your projects. + +#### Maven / JitPack + +```xml + + + com.github.wiremock + wiremock-testcontainers-java + ${wiremock-testcontainers.version} + test + + + + + + + jitpack.io + https://jitpack.io + + +``` + +
+ +Gradle / JitPack + + +#### Gradle / JitPack + +```groovy + allprojects { + repositories { + maven { url 'https://jitpack.io' } + } + } + + dependencies { + testImplementation 'com.github.wiremock:wiremock-testcontainers-java:${wiremock-testcontainers.version}' + } + +``` +
+ +
+ +Maven / GitHub Packages + + +#### Maven / GitHub Packages + +GitHub Packages uses the official Maven coordinates, +but you will need to configure the server and authentication. + ```xml org.wiremock.integrations.testcontainers @@ -32,6 +90,8 @@ A common example is using Wiremock 3.x with Java 1.8. ``` +
+ ### Using the test container in JUnit 4/5 P.S: Javadoc is coming soon!