-
Notifications
You must be signed in to change notification settings - Fork 122
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Update uber-JAR build instructions
- Loading branch information
Showing
5 changed files
with
13 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -59,25 +59,25 @@ See all of our SDKs and integrations on the [Vonage Developer portal](https://de | |
|
||
Releases are published to [Maven Central](https://central.sonatype.com/artifact/com.vonage/server-sdk). | ||
Instructions for your build system can be found in the snippets section. | ||
Release notes can be found in the [changelog](CHANGELOG.md). | ||
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/). | ||
|
||
Release notes for each version can be found in the [changelog](CHANGELOG.md). | ||
|
||
### Build It Yourself | ||
|
||
Alternatively you can clone the repo and build the JAR file yourself: | ||
|
||
```bash | ||
git clone [email protected]:vonage/vonage-java-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-java-sdk/releases/), | ||
containing the Java 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 required to run the SDK included, | ||
which can be found in the `target` directory. The `install` goal will make the SDK and its dependencies | ||
available in your local Maven repository (usually located under your `~/.m2` directory), which can then | ||
be used from other projects locally on your machine. To use this in a Gradle project, you need to include | ||
the dependency co-ordinates and add `mavenLocal()` to the `repositories` block in your `build.gradle` file. | ||
|
||
## Usage | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters