Skip to content

Commit

Permalink
docs: minor Java SDK README updates (#193)
Browse files Browse the repository at this point in the history
minor edits to wording and structure

Co-authored-by: Morgan Kleene <[email protected]>
  • Loading branch information
damorris25 and mkleene authored Oct 14, 2024
1 parent 02fd7e6 commit e9dc738
Showing 1 changed file with 13 additions and 18 deletions.
31 changes: 13 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
# java-sdk
# OpenTDF Java SDK

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

```xml
<dependency>
<groupId>io.opentdf/platform</groupId>
<artifactId>sdk</artifactId>
</dependency>
```
### Additional Maven Modules
- cmdline: Command line utility



## SDK Usage

### TDF File Creation and Reading
## Quick Start Example

```java
import io.opentdf.platform.sdk.Config;
Expand Down Expand Up @@ -48,7 +46,8 @@ public class Example {

### Cryptography Library

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

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

### Logging

We use [slf4j](https://www.slf4j.org/), without providing a backend. We use log4j2 in our tests.
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.

### SSL - Untrusted Certificates

Use the SDKBuilder.withSSL... methods to build an SDKBuilder with:
Leverage the SDKBuilder.withSSL methods to create an SDKBuilder as follows:

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

### Maven Modules
- cmdline: Command line utility
- sdk: The OpenTDF Java SDK

### Buf

Create an account, link with GitHub, under User setting, Create a `token`
Create an account, link that account with GitHub and then under User settings create a `token`

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

### RELEASE

Releases are from tags created by GitHub Release process.
Release Please trigger the release process.
Releases are from tags created by the GitHub release process.
Enter 'Release Please' to trigger the release process.

0 comments on commit e9dc738

Please sign in to comment.