From e7c67dd4158a1aaf5c7908029a205c66a750278e Mon Sep 17 00:00:00 2001 From: nex Date: Tue, 21 Jul 2020 14:34:33 +0800 Subject: [PATCH] Update docs --- README.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 63 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6f6c858..6a7d187 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,27 @@ -## Dependencies: +## Usage + +Import `bdledger-java-sdk-{{VERSION}}.jar` along with SDK's dependencies described below. + +See Javadoc and `src/test/java/org/bdware/bdledger/api/grpc/ClientTests.java` for usage example. + +## SDK's dependencies + +### Direct dependencies - io.grpc:grpc-netty-shaded - io.grpc:grpc-protobuf - io.grpc:grpc-stub -w/ **Gradle** +grpc_java_version = '1.27.0' + +with **Gradle** ``` compile 'io.grpc:grpc-netty-shaded:' + grpc_java_version compile 'io.grpc:grpc-protobuf:' + grpc_java_version compile 'io.grpc:grpc-stub:' + grpc_java_version ``` -w/ **Maven** +with **Maven** ``` io.grpc @@ -30,13 +40,58 @@ w/ **Maven** ``` -## Usage +### All dependencies -See Javadoc and `src/test/java/bdchain/api/*Tests.java` files. +``` ++--- io.grpc:grpc-netty-shaded:1.27.0 +| \--- io.grpc:grpc-core:[1.27.0] -> 1.27.0 +| +--- io.grpc:grpc-api:[1.27.0] -> 1.27.0 +| | +--- io.grpc:grpc-context:1.27.0 +| | +--- com.google.errorprone:error_prone_annotations:2.3.4 +| | +--- com.google.code.findbugs:jsr305:3.0.2 +| | +--- org.codehaus.mojo:animal-sniffer-annotations:1.18 +| | \--- com.google.guava:guava:28.1-android +| | +--- com.google.guava:failureaccess:1.0.1 +| | +--- com.google.guava:listenablefuture:9999.0-empty-to-avoid-conflict-with-guava +| | +--- org.checkerframework:checker-compat-qual:2.5.5 +| | \--- com.google.j2objc:j2objc-annotations:1.3 +| +--- com.google.code.gson:gson:2.8.6 +| +--- com.google.android:annotations:4.1.1.4 +| +--- com.google.errorprone:error_prone_annotations:2.3.4 +| \--- io.perfmark:perfmark-api:0.19.0 +| \--- com.google.code.findbugs:jsr305:3.0.2 ++--- io.grpc:grpc-protobuf:1.27.0 +| +--- io.grpc:grpc-api:1.27.0 (*) +| +--- com.google.protobuf:protobuf-java:3.11.0 +| +--- com.google.guava:guava:28.1-android (*) +| +--- com.google.api.grpc:proto-google-common-protos:1.17.0 +| \--- io.grpc:grpc-protobuf-lite:1.27.0 +| +--- io.grpc:grpc-api:1.27.0 (*) +| \--- com.google.guava:guava:28.1-android (*) ++--- io.grpc:grpc-stub:1.27.0 +| \--- io.grpc:grpc-api:1.27.0 (*) +\--- javax.annotation:javax.annotation-api:1.3.2 + +``` ## Testing -1. Download [mock servers](https://public.internetapi.cn/?dir=bdchain/test) for Transaction Ledger & - Accounting Chain -2. Run mock servers with ```--port={{port}}``` +1. Download [mock client](https://public.internetapi.cn/?dir=bdledger/test) +2. Run mock client with ```--port={{port}}``` 3. Run ```gradle test``` + +## Distributing + +``` +./gradlew jar +./gradlew shadowJar +./gradlew javadoc +./gradlew installDist +./gradlew distZip +``` + +## TODO + +Would you like to use a free managed security reporting service (recommended)? +Put https://hackerone.com/central-security-project/reports/new as your project's security issue reporting URL. We'll take care of the rest. +For more details on the Central Security Project, visit https://www.sonatype.com/central-security-project