Skip to content

Commit a842b8f

Browse files
committed
docs: Further guidance on installation
1 parent 985b07c commit a842b8f

File tree

5 files changed

+73
-34
lines changed

5 files changed

+73
-34
lines changed

.github/workflows/codeql.yml

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: "CodeQL Advanced"
1+
name: "CodeQL"
22
on:
33
push:
44
branches: [ "main" ]
@@ -48,26 +48,8 @@ jobs:
4848
# If you wish to specify custom queries, you can do so here or in a config file.
4949
# By default, queries listed here will override any specified in a config file.
5050
# Prefix the list here with "+" to use these queries and those in the config file.
51-
5251
# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
5352
# queries: security-extended,security-and-quality
54-
55-
# If the analyze step fails for one of the languages you are analyzing with
56-
# "We were unable to automatically build your code", modify the matrix above
57-
# to set the build mode to "manual" for that language. Then modify this step
58-
# to build your code.
59-
# ℹ️ Command-line programs to run using the OS shell.
60-
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
61-
- if: matrix.build-mode == 'manual'
62-
shell: bash
63-
run: |
64-
echo 'If you are using a "manual" build mode for one or more of the' \
65-
'languages you are analyzing, replace this with the commands to build' \
66-
'your code, for example:'
67-
echo ' make bootstrap'
68-
echo ' make release'
69-
exit 1
70-
7153
- name: Perform CodeQL Analysis
7254
uses: github/codeql-action/analyze@cbe18979603527f12c7871a6eb04833ecf1548c7
7355
with:

README.md

Lines changed: 48 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
# Vonage Server SDK for Kotlin (JVM)
22

33
[![Maven Central](https://img.shields.io/maven-central/v/com.vonage/server-sdk-kotlin)](https://central.sonatype.com/artifact/com.vonage/server-sdk-kotlin)
4-
[![KDoc](https://javadoc.io/badge2/com.vonage/server-sdk-kotlin/javadoc.svg)](https://javadoc.io/doc/com.vonage/server-sdk-kotlin)
54
[![Build Status](https://github.com/Vonage/vonage-kotlin-sdk/actions/workflows/build.yml/badge.svg)](https://github.com/Vonage/vonage-kotlin-sdk/actions/workflows/build.yml)
65
![CodeQL](https://github.com/Vonage/vonage-kotlin-sdk/actions/workflows/codeql.yml/badge.svg)
76
[![codecov](https://codecov.io/gh/Vonage/vonage-kotlin-sdk/graph/badge.svg?token=YNBJUD8OUT)](https://codecov.io/gh/Vonage/vonage-kotlin-sdk)
87
![SLOC](https://sloc.xyz/github/Vonage/vonage-kotlin-sdk)
98
[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/Vonage/vonage-kotlin-sdk/badge)](https://scorecard.dev/viewer/?uri=github.com/Vonage/vonage-kotlin-sdk)
10-
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
11-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE.txt)
9+
<!--[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
10+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE.txt)-->
1211

1312
This Kotlin SDK allows you to use [Vonage APIs](https://developer.vonage.com/api) in any JVM-based application.
1413
You'll need to have [created a Vonage account](https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=java-client-library).
@@ -45,17 +44,49 @@ We also provide server SDKs in other languages:
4544
- [.NET](https://github.com/Vonage/vonage-dotnet-sdk)
4645
- [PHP](https://github.com/Vonage/vonage-php-sdk)
4746
- [Python](https://github.com/Vonage/vonage-python-sdk)
48-
- [Ruby](https://github.com/Vonage/vonage-ruby-sdk)
4947
- [NodeJS](https://github.com/Vonage/vonage-node-sdk)
48+
- [Ruby](https://github.com/Vonage/vonage-ruby-sdk)
5049

51-
We also offer [client-side SDKs](https://developer.vonage.com/en/vonage-client-sdk/overview) for iOS, Android and JavaScript.
50+
We also offer [client-side SDKs](https://developer.vonage.com/en/vonage-client-sdk/overview) for Android, iOS and JavaScript.
5251
See all of our SDKs and integrations on the [Vonage Developer portal](https://developer.vonage.com/en/tools).
5352

5453
## Installation
5554
Releases are published to [Maven Central](https://central.sonatype.com/artifact/com.vonage/server-sdk-kotlin).
5655
Instructions for your build system can be found in the snippets section.
57-
They're also available from [here](https://mvnrepository.com/artifact/com.vonage/server-sdk-kotlin/latest).
58-
Release notes can be found in the [changelog](CHANGELOG.md).
56+
They're also available from [here](https://search.maven.org/artifact/com.vonage/server-sdk-kotlin/1.1.0/jar).
57+
Release notes for each version can be found in the [changelog](CHANGELOG.md).
58+
59+
Here are the instructions for including the SDK in your project:
60+
61+
### Gradle
62+
#### Groovy DSL
63+
Add the following to your `build.gradle` file:
64+
65+
```groovy
66+
dependencies {
67+
implementation "com.vonage:server-sdk-kotlin:1.1.0"
68+
}
69+
```
70+
71+
#### Kotlin DSL
72+
Add the following to your `build.gradle.kts` file:
73+
74+
```kotlin
75+
dependencies {
76+
implementation("com.vonage:server-sdk-kotlin:1.1.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-kotlin</artifactId>
87+
<version>1.1.0</version>
88+
</dependency>
89+
```
5990

6091
### Build It Yourself
6192

@@ -73,6 +104,7 @@ The `uberjar` profile will create a JAR file with all dependencies included in t
73104
directory at the root of the repo. You can then include this in your project's classpath.
74105

75106
## Configuration
107+
The SDK requires very little configuration to get started.
76108

77109
## Typical Instantiation
78110
For default configuration, you just need to specify your Vonage account credentials using API key and secret,
@@ -125,16 +157,21 @@ These are inner classes defined for each API resources and are always prefixed w
125157
`ExistingCall`, `ExistingSession`, `ExistingApplication` etc. As a general rule, resources with unique identifiers
126158
have a corresponding `Existing[Resource]` class which is used to perform operations on that resource, rather
127159
than repeatedly passing the ID of that resource to methods on the parent class, as is the case in the Java SDK.
160+
These resource classes are constructed from a method call in the top-level API class. So, for example, to work with
161+
an `ExistingSession`, you would do: `client.video.session(SESSION_ID)`, where `client` is an instance of `Vonage` and
162+
`SESSION_ID` is the unique identifier of the video session you want to work with.
128163

129164
### Examples
130165
You can find complete runnable code samples in the [Code Snippets repository](https://github.com/Vonage/vonage-kotlin-code-snippets),
131166
including [a searchable list of snippets](https://github.com/Vonage/vonage-kotlin-code-snippets/blob/main/SNIPPETS.md).
132167

133168
### Documentation
134-
The SDK is fully documented with KDocs, so you should have complete documentation from your IDE. You may need to
135-
click "Download Sources" in IntelliJ to get the full documentation. Alternatively, you can browse the documentation
136-
using a service such as [Javadoc.io](https://javadoc.io/doc/com.vonage/server-sdk-kotlin/latest/server-sdk-kotlin/com.vonage.client.kt/index.html),
137-
which renders the documentation for you from [the artifacts on Maven Central](https://repo.maven.apache.org/maven2/com/vonage/server-sdk-kotlin/).
169+
[![javadoc](https://javadoc.io/badge2/com.vonage/server-sdk-kotlin/javadoc.svg)](https://javadoc.io/doc/com.vonage/server-sdk-kotlin)
170+
171+
The SDK is fully documented with [KDocs](https://kotlinlang.org/docs/kotlin-doc.html), so you should have complete
172+
documentation from your IDE. You may need to click "Download Sources" in IntelliJ to get the full documentation.
173+
Alternatively, you can browse the documentation using a service like [Javadoc.io](https://javadoc.io/doc/com.vonage/server-sdk-kotlin/1.1.0/index.html),
174+
which renders the documentation for you from [the artifacts on Maven Central](https://repo.maven.apache.org/maven2/com/vonage/server-sdk-kotlin/1.1.0/).
138175

139176
For help with any specific APIs, refer to the relevant documentation on our [developer portal](https://developer.vonage.com/en/documentation),
140177
using the links provided in the [Supported APIs](#supported-apis) section. For completeness, you can also consult the

SECURITY.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Security Policy
2+
Ths file describes how security issues are handled in the Vonage Kotlin SDK.
23

34
## Supported Versions
4-
Only the latest version of the SDK is supported.
5+
Only the latest version of the SDK is supported. The timeline for fixing issues is within the next two releases
6+
of it being reported and fixed. This is to cover the scenario where an issue is reported just before or after
7+
a planned release, to allow time for the fix to be included in the next release.
58

69
## Reporting a Vulnerability
7-
810
To report a security concern, use the "[Report a Vulnerability](https://github.com/Vonage/vonage-kotlin-sdk/security/advisories/new)" tab.
911
You can also contact the Developer Relations team directly via [email](devrel@vonage.com) for more private disclosure.
1012
You can also [raise an Issue](https://github.com/Vonage/vonage-kotlin-sdk/issues/new/choose) and/or create a [Pull Request](https://github.com/Vonage/vonage-kotlin-sdk/pulls) from your fork of the repo.

pom.xml

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
<groupId>com.vonage</groupId>
77
<artifactId>server-sdk-kotlin</artifactId>
8-
<version>1.1.1</version>
8+
<version>1.1.0</version>
99

1010
<name>Vonage Kotlin Server SDK</name>
1111
<description>Kotlin client for Vonage APIs</description>
@@ -109,6 +109,24 @@
109109
match="VONAGE_KOTLIN_SDK_VERSION = &quot;.+&quot;"
110110
replace="VONAGE_KOTLIN_SDK_VERSION = &quot;${project.version}&quot;"
111111
/>
112+
<replaceregexp
113+
file="README.md"
114+
match="\/server-sdk-kotlin\/([0-9\.]+)\/"
115+
replace="\/server-sdk-kotlin\/${project.version}\/"
116+
flags="g"
117+
/>
118+
<replaceregexp
119+
file="README.md"
120+
match="vonage:server-sdk-kotlin:.+&quot;"
121+
replace="vonage:server-sdk-kotlin:${project.version}&quot;"
122+
flags="g"
123+
/>
124+
<replaceregexp
125+
file="README.md"
126+
match="&lt;version&gt;.+&lt;/version&gt;"
127+
replace="&lt;version&gt;${project.version}&lt;\/version&gt;"
128+
flags="g"
129+
/>
112130
</target>
113131
</configuration>
114132
</execution>

src/main/kotlin/com/vonage/client/kt/Vonage.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ package com.vonage.client.kt
1818
import com.vonage.client.HttpConfig
1919
import com.vonage.client.VonageClient
2020

21-
const val VONAGE_KOTLIN_SDK_VERSION = "1.1.1"
21+
const val VONAGE_KOTLIN_SDK_VERSION = "1.1.0"
2222
private const val SDK_USER_AGENT = "vonage-kotlin-sdk/$VONAGE_KOTLIN_SDK_VERSION"
2323

2424
/**

0 commit comments

Comments
 (0)