Skip to content

Commit e9dc738

Browse files
damorris25mkleene
andauthored
docs: minor Java SDK README updates (#193)
minor edits to wording and structure Co-authored-by: Morgan Kleene <mkleene@virtru.com>
1 parent 02fd7e6 commit e9dc738

File tree

1 file changed

+13
-18
lines changed

1 file changed

+13
-18
lines changed

README.md

+13-18
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
1-
# java-sdk
1+
# OpenTDF Java SDK
22

3-
This repository provides the OpenTDF Java SDK.
4-
It will be available from maven central as:
3+
A Java implementation of the OpenTDF protocol, and access library for the services provided by the OpenTDF platform.
4+
This SDK is available from Maven central as:
55

66
```xml
77
<dependency>
88
<groupId>io.opentdf/platform</groupId>
99
<artifactId>sdk</artifactId>
1010
</dependency>
1111
```
12+
### Additional Maven Modules
13+
- cmdline: Command line utility
1214

13-
14-
15-
## SDK Usage
16-
17-
### TDF File Creation and Reading
15+
## Quick Start Example
1816

1917
```java
2018
import io.opentdf.platform.sdk.Config;
@@ -48,7 +46,8 @@ public class Example {
4846

4947
### Cryptography Library
5048

51-
The SDK uses the [Bouncy Castle Security library](https://www.bouncycastle.org/). SDK users may need to register the Bouncy Castle Provider; e.g.:
49+
This SDK uses the [Bouncy Castle Security library](https://www.bouncycastle.org/) library.
50+
Note: When using this SDK, it may be necessary to register the Bouncy Castle Provider as follows:
5251

5352
```java
5453
static{
@@ -58,23 +57,19 @@ The SDK uses the [Bouncy Castle Security library](https://www.bouncycastle.org/)
5857

5958
### Logging
6059

61-
We use [slf4j](https://www.slf4j.org/), without providing a backend. We use log4j2 in our tests.
60+
The Java SDK makes use of the [slf4j](https://www.slf4j.org/) library, without providing a backend. log4j2 in leveraged within the included automated tests.
6261

6362
### SSL - Untrusted Certificates
6463

65-
Use the SDKBuilder.withSSL... methods to build an SDKBuilder with:
64+
Leverage the SDKBuilder.withSSL methods to create an SDKBuilder as follows:
6665

6766
- An SSLFactory: ```sdkBuilder.sslFactory(mySSLFactory)```
6867
- Directory containing trusted certificates: ```sdkBuilder.sslFactoryFromDirectory(myDirectoryWithCerts)```
6968
- Java Keystore: ```sdkBuilder.sslFactoryFromKeyStore(keystorepath, keystorePassword)```
7069

71-
### Maven Modules
72-
- cmdline: Command line utility
73-
- sdk: The OpenTDF Java SDK
74-
7570
### Buf
7671

77-
Create an account, link with GitHub, under User setting, Create a `token`
72+
Create an account, link that account with GitHub and then under User settings create a `token`
7873

7974
```shell
8075
[INFO] --- antrun:3.1.0:run (generateSources) @ sdk ---
@@ -96,5 +91,5 @@ mvn versions:set -DnewVersion=1.2.3-SNAPSHOT
9691

9792
### RELEASE
9893

99-
Releases are from tags created by GitHub Release process.
100-
Release Please trigger the release process.
94+
Releases are from tags created by the GitHub release process.
95+
Enter 'Release Please' to trigger the release process.

0 commit comments

Comments
 (0)