add readme

[bytom/bytom-java-sdk.git] / README.md

diff --git a/README.md b/README.md
index e69de29..7260f58 100644 (file)
--- a/README.md
+++ b/README.md
@@ -0,0 +1,8 @@
+## Bytom Java SDK 
+
+Bytom java sdk contains two modules:
+
+1. java-sdk encapsulates of the request data and return value of the bytom api,The signature of the transaction needs to be completed online.See the [java-sdk documentation](java-sdk/README.md) for details.
+
+2. tx-signer implementation offline signature of transaction, see the [tx-signer documentation](tx-signer/README.md) for details.
+