Skip to content

Commit 49e24d7

Browse files
committed
docs: Add build tool instructions to README
1 parent 0a3af39 commit 49e24d7

File tree

3 files changed

+43
-3
lines changed

3 files changed

+43
-3
lines changed

.github/workflows/publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ jobs:
5151
- type: "header"
5252
text:
5353
type: "plain_text"
54-
text: ":initial_external_notification_sent: Version ${{ github.event.release.name }} of the Java Server SDK has been released."
54+
text: ":initial_external_notification_sent: Java Server SDK ${{ github.event.release.name }} has been released."
5555
- type: "section"
5656
text:
5757
type: "mrkdwn"
@@ -61,4 +61,4 @@ jobs:
6161
- type: "section"
6262
text:
6363
type: "mrkdwn"
64-
text: "You can view the full change log <${{github.event.release.html_url }}|here>."
64+
text: "View the full change log <${{github.event.release.html_url }}|here>."

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
![CodeQL](https://github.com/Vonage/vonage-java-sdk/actions/workflows/codeql.yml/badge.svg)
77
[![codecov](https://codecov.io/gh/vonage/vonage-java-sdk/branch/main/graph/badge.svg)](https://codecov.io/gh/vonage/vonage-java-sdk)
88
[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/Vonage/vonage-java-sdk/badge)](https://scorecard.dev/viewer/?uri=github.com/Vonage/vonage-java-sdk)
9-
![SLOC](https://sloc.xyz/github/vonage/vonage-java-sdk?)
9+
![SLOC](https://sloc.xyz/github/vonage/vonage-java-sdk)
1010
[![Snyk](https://snyk.io/test/github/vonage/vonage-java-sdk/badge.svg)](https://snyk.io/test/github/vonage/vonage-java-sdk)
1111
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.1%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
1212
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE.txt)
@@ -66,6 +66,28 @@ such as [Maven](https://maven.apache.org/), [Gradle](https://gradle.org/) or [Iv
6666

6767
Release notes for each version can be found in the [changelog](CHANGELOG.md).
6868

69+
Here are the instructions for including the SDK in your project:
70+
71+
### Gradle
72+
Add the following to your `build.gradle` or `build.gradle.kts` file:
73+
74+
```groovy
75+
dependencies {
76+
implementation("com.vonage:server-sdk:9.0.0")
77+
}
78+
```
79+
80+
### Maven
81+
Add the following to the `<dependencies>` section of your `pom.xml` file:
82+
83+
```xml
84+
<dependency>
85+
<groupId>com.vonage</groupId>
86+
<artifactId>server-sdk</artifactId>
87+
<version>9.0.0</version>
88+
</dependency>
89+
```
90+
6991
### Build It Yourself
7092

7193
Alternatively you can clone the repo and build the JAR file yourself:

pom.xml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,24 @@
164164
match="CLIENT_VERSION = &quot;.+&quot;"
165165
replace="CLIENT_VERSION = &quot;${project.version}&quot;"
166166
/>
167+
<replaceregexp
168+
file="README.md"
169+
match="\/server-sdk\/([0-9\.]+)\/"
170+
replace="\/server-sdk\/${project.version}\/"
171+
flags="g"
172+
/>
173+
<replaceregexp
174+
file="README.md"
175+
match="vonage:server-sdk:.+&quot;"
176+
replace="vonage:server-sdk:${project.version}&quot;"
177+
flags="g"
178+
/>
179+
<replaceregexp
180+
file="README.md"
181+
match="&lt;version&gt;.+&lt;/version&gt;"
182+
replace="&lt;version&gt;${project.version}&lt;\/version&gt;"
183+
flags="g"
184+
/>
167185
</target>
168186
</configuration>
169187
</execution>

0 commit comments

Comments
 (0)