diff --git a/README.md b/README.md index 81cf2a6f..c13acf74 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,37 @@ # java-sdk -OpenTDF Java SDK +This repository provides the OpenTDF Java SDK. +It will be available from maven central as: -### SDK Usage -The SDK uses the [Bouncy Castle Security library](https://www.bouncycastle.org/). SDK users may need to register the Bouncy Castle Provider; e.g.: +```xml + + io.opentdf/platform + sdk + ``` + + + +## SDK Usage + +### 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.: + +```java static{ Security.addProvider(new BouncyCastleProvider()); } ``` ### Logging + We use [slf4j](https://www.slf4j.org/), without providing a backend. We use log4j2 in our tests. ### SSL - Untrusted Certificates + Use the SDKBuilder.withSSL... methods to build an SDKBuilder with: + - An SSLFactory: ```sdkBuilder.sslFactory(mySSLFactory)``` - Directory containing trusted certificates: ```sdkBuilder.sslFactoryFromDirectory(myDirectoryWithCerts)``` - Java Keystore: ```sdkBuilder.sslFactoryFromKeyStore(keystorepath, keystorePassword)``` diff --git a/sdk/README.md b/sdk/README.md index 306f5cda..c3ccb3ff 100644 --- a/sdk/README.md +++ b/sdk/README.md @@ -2,7 +2,7 @@ OpenTDF Java SDK -## Sketch for API +## Usage: maybe this is too fluent?