From c30fc65064aed542ede2c23a4e83076d24e9d6d7 Mon Sep 17 00:00:00 2001 From: Sina Madani Date: Tue, 27 Aug 2024 11:12:51 +0100 Subject: [PATCH] docs: Update build instructions --- README.md | 15 ++++++--------- pom.xml | 2 +- 2 files changed, 7 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 5ac084f..0daf900 100644 --- a/README.md +++ b/README.md @@ -55,21 +55,18 @@ Release notes can be found in the [changelog](CHANGELOG.md). ### Build It Yourself +**Note**: We *strongly recommend* that you use a tool that supports dependency management, +such as [Maven](https://maven.apache.org/), [Gradle](https://gradle.org/) or [Ivy](http://ant.apache.org/ivy/). + Alternatively you can clone the repo and build the JAR file yourself: ```bash git clone git@github.com:vonage/vonage-kotlin-sdk.git -mvn install +mvn install -P uberjar ``` -### Download everything in a ZIP file - -**Note**: We *strongly recommend* that you use a tool that supports dependency management, -such as [Maven](https://maven.apache.org/), [Gradle](https://gradle.org/) or [Ivy](http://ant.apache.org/ivy/). - -We provide a [ZIP file for each release](https://github.com/Vonage/vonage-kotlin-sdk/releases/), -containing the Kotlin Server SDK JAR, along with all the dependencies. Download the file, unzip it, and add the JAR files -to your project's classpath. +The `uberjar` profile will create a JAR file with all dependencies included in the `target` +directory at the root of the repo. You can then include this in your project's classpath. ## Configuration diff --git a/pom.xml b/pom.xml index 19a8134..9f90a5c 100644 --- a/pom.xml +++ b/pom.xml @@ -263,7 +263,7 @@ - fat-jar + uberjar