Skip to content

Commit c70959e

Browse files
committed
doc: README update
1 parent 76b0329 commit c70959e

1 file changed

Lines changed: 17 additions & 14 deletions

File tree

README.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Sinch Java SDK
22

3-
Here you'll find documentation related to the Sinch Java SDK, including how to install it, initialize it, and start developing <language> code using Sinch services.
3+
Here you'll find documentation related to the Sinch Java SDK, including how to install it, initialize it, and start developing Java code using Sinch services.
44

55
To use Sinch services, you'll need a Sinch account and access keys. You can sign up for an account and create access keys at [dashboard.sinch.com](https://dashboard.sinch.com).
66

7-
For more information on the Sinch APIs on which this SDK is based, refer to the official [developer documentation portal](https://developers.sinch.com).
7+
For more information on the SDK, refer to the dedicated [Java SDK documentation section](https://developers.sinch.com/docs/sdks/java) and for the Sinch APIs on which this SDK is based, refer to the official [developer documentation portal](https://developers.sinch.com).
88

99
## Table of contents:
1010
- [Prerequisites](#prerequisites)
@@ -14,7 +14,7 @@ For more information on the Sinch APIs on which this SDK is based, refer to the
1414
- [Logging](#logging)
1515
- [Onboarding](#onboarding)
1616
- [Third-party dependencies](#third-party-dependencies)
17-
- [Migration guide for previous SDK versions](#migration-guides)
17+
- [Changelog and Migration guides](#changelog--migration)
1818

1919
## Prerequisites
2020

@@ -25,7 +25,7 @@ For more information on the Sinch APIs on which this SDK is based, refer to the
2525

2626
## Installation
2727

28-
Add to your `pom.xml` file the dependency to SDK:
28+
Add the SDK dependency to your `pom.xml` file:
2929
```xml
3030
<dependencies>
3131
<dependency>
@@ -36,7 +36,7 @@ Add to your `pom.xml` file the dependency to SDK:
3636
...
3737
</dependencies>
3838
```
39-
Note the `${sdk.version}` need to be set according to released version to be used (see available versions from [Maven Repository](https://central.sonatype.com/artifact/com.sinch.sdk/sinch-sdk-java))
39+
Note: The `${sdk.version}` needs to be set according to the released version to be used (see available versions from [Maven Repository](https://central.sonatype.com/artifact/com.sinch.sdk/sinch-sdk-java))
4040

4141
## Getting started
4242

@@ -81,7 +81,7 @@ Here is the list of the Sinch products and their level of support by the Java SD
8181

8282
The SDK uses the Java 8 logging feature ([java.util.logging](https://docs.oracle.com/javase/8/docs/api/java/util/logging/package-summary.html#package.description))
8383

84-
When using java logging, Loggers and severity can be configured by using a `logging.properties` file like:
84+
When using Java logging, Loggers and severity can be configured by using a `logging.properties` file like:
8585
```
8686
# java.util.logging configuration sample
8787
# See https://docs.oracle.com/javase/8/docs/api/java/util/logging/package-summary.html#package.description
@@ -111,28 +111,27 @@ If you are using a different logging framework (such as SLF4J or Spring), please
111111

112112
To enhance the onboarding experience, the following resources are available:
113113
- Sinch Online Developers Documentation: https://developers.sinch.com
114-
- Java SDK Online Javadoc: https://www.javadoc.io/doc/com.sinch.sdk/sinch-sdk-java/latest
115-
- Java SDK Quickstart Repository: A repository with tutorials and templates to help you quickly start a new project: https://github.com/sinch/sinch-sdk-java-quickstart
116-
- Java SDK Snippets: A collection of basic code snippets for reference: [snippets](examples/snippets/README.md)
114+
- Java SDK Online Javadoc: https://www.javadoc.io/doc/com.sinch.sdk/sinch-sdk-java
115+
- Java SDK examples: A collection of basic code snippets, tutorials and getting started for reference: [examples](examples/README.md)
117116

118117
## Third-party dependencies
119118
The SDK relies on the following third-party dependencies:
120119
- [Jackson's library](https://github.com/FasterXML/jackson-jakarta-rs-providers): Provides JSON serialization/deserialization functionality.
121-
- [Apache HTTP client](https://hc.apache.org/httpcomponents-client-5.4.x/5.4.1/httpclient5/project-info.html): Manages communication with Sinch products' REST APIs
120+
- [Apache HTTP client](https://hc.apache.org/httpcomponents-client-ga/): Manages communication with Sinch products' REST APIs
122121

123122
### Jackson/Java EE/jaxrs/Jakarta Compatibility Consideration
124-
The transition from <code>javax</code> to <code>jakarta</code> namespaces with the Java EE to Jakarta EE migration may cause compatibility issues. Refer to [Oracle's note about the transition](https://blogs.oracle.com/javamagazine/post/transition-from-java-ee-to-jakarta-ee) for additional details.
123+
The transition from `javax` to `jakarta` namespaces with the Java EE to Jakarta EE migration may cause compatibility issues. Refer to [Oracle's note about the transition](https://docslib.org/doc/1185955/transition-from-java-ee-to-jakarta-ee-ee-conclusion-what-happened-and-what-you-need-to-know) for additional details.
125124

126125
Jackson maintainers provide two variants of the library:
127126
> (*) NOTE: Jakarta-RS is the package under jakarta.ws.rs, replacing older JAX-RS which lived under javax.ws.rs. For JAX-RS variant, see repo jackson-jaxrs-providers
128127
129128
By default, the Sinch Java SDK uses the "new" [jackson-jakarta-rs-providers](https://github.com/FasterXML/jackson-jakarta-rs-providers). However, you can switch to the "older" [jackson-jaxrs-providers](https://github.com/FasterXML/jackson-jaxrs-providers) if required.
130129

131-
#### Switching to <code>jackson-jaxrs-providers</code>
132-
Depending on your use case, you may need to adjust dependencies to enable <code>jaxrs</code> usage.
130+
#### Switching to `jackson-jaxrs-providers`
131+
Depending on your use case, you may need to adjust dependencies to enable `jaxrs` usage.
133132

134133
Add the following dependency to your configuration:
135-
Note: Replace <code>VERSION-YOU-WANT-TO-BE-USED</code> by a Jackson version of at least `2.15.2`.
134+
Note: Replace `VERSION-YOU-WANT-TO-BE-USED` with a Jackson version of at least `2.15.2`.
136135
```xml
137136
...
138137
<dependency>
@@ -158,6 +157,10 @@ Note: Replace <code>VERSION-YOU-WANT-TO-BE-USED</code> by a Jackson version of a
158157
For information about the latest changes in the SDK, please refer to the [CHANGELOG](CHANGELOG.md) file
159158
and the [MIGRATION-GUIDE](MIGRATION-GUIDE.md) for instructions on how to update your code when upgrading to a new major version of the SDK.
160159

160+
## Contact
161+
162+
Developer Experience engineering team: [team-developer-experience@sinch.com](mailto:team-developer-experience@sinch.com)
163+
161164
## License
162165

163166
This project is licensed under the Apache License.

0 commit comments

Comments
 (0)