Skip to content

Commit f7d443d

Browse files
committed
docs: Tidy up README
1 parent a60d92e commit f7d443d

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ Release notes can be found in the [changelog](CHANGELOG.md).
5656

5757
### Build It Yourself
5858

59-
**Note**: We *strongly recommend* that you use a tool that supports dependency management,
60-
such as [Maven](https://maven.apache.org/), [Gradle](https://gradle.org/) or [Ivy](http://ant.apache.org/ivy/).
59+
**Note**: We *strongly recommend* that you use a tool with dependency management,
60+
such as [Maven](https://maven.apache.org/) or [Gradle](https://gradle.org/).
6161

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

@@ -72,9 +72,9 @@ directory at the root of the repo. You can then include this in your project's c
7272
## Configuration
7373

7474
## Typical Instantiation
75-
For default configuration, you just need to specify your Vonage account credentials using API key and secret, private
76-
key and application ID or both. For maximum compatibility with all APIs, it is recommended that you specify both
77-
authentication methods, like so:
75+
For default configuration, you just need to specify your Vonage account credentials using API key and secret,
76+
private key and application ID or both. For maximum compatibility with all APIs, it is recommended that you
77+
specify both authentication methods, like so:
7878

7979
```kotlin
8080
import com.vonage.client.kt.Vonage
@@ -87,11 +87,11 @@ val vonage = Vonage {
8787
```
8888

8989
You can also use environment variables for convenience, by setting the following:
90-
- `VONAGE_API_KEY`
91-
- `VONAGE_API_SECRET`
92-
- `VONAGE_SIGNATURE_SECRET`
93-
- `VONAGE_APPLICATION_ID`
94-
- `VONAGE_PRIVATE_KEY_PATH`
90+
- `VONAGE_API_KEY` - Your account API key
91+
- `VONAGE_API_SECRET` - Your account API secret
92+
- `VONAGE_SIGNATURE_SECRET` - (Advanced, optional) Signature secret for signed requests when using SMS API
93+
- `VONAGE_APPLICATION_ID` - UUID of the Vonage application you want to use
94+
- `VONAGE_PRIVATE_KEY_PATH` - Absolute path to the private key file for the application
9595

9696
and then instantiate the client with:
9797

@@ -117,10 +117,11 @@ val vonageClient = Vonage {
117117

118118
**Q: Why use this SDK instead of the [Vonage Java Server SDK](https://github.com/Vonage/vonage-java-sdk)?**
119119

120-
**A:** This Kotlin SDK is actually based on the to improve the user experience in Kotlin. It adds
120+
**A:** This Kotlin SDK is actually based on the Java SDK to improve the user experience in Kotlin. It adds
121121
syntactic sugar, so you can avoid the cumbersome builder pattern in favour of a more idiomatic DSL-like
122-
syntax. Furthermore, you are more partially shielded from "platform types" (the `!`) so you have a better
123-
idea of what is and isn't nullable when creating requests.
122+
syntax, optional and named parameters with default values etc. whilst still reataining the strong typing
123+
offered by the Java SDK. Furthermore, you are more partially shielded from "platform types" (the `!`)
124+
so you have a better idea of what is and isn't nullable when creating requests.
124125

125126
**Q: What is your policy on thread safety?**
126127

0 commit comments

Comments
 (0)