Skip to content

Commit

Permalink
docs: Update build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
SMadani committed Aug 27, 2024
1 parent 6cc5cf2 commit c30fc65
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 10 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@
</profile>

<profile>
<id>fat-jar</id>
<id>uberjar</id>
<build>
<plugins>
<plugin>
Expand Down

0 comments on commit c30fc65

Please sign in to comment.