add readme

diff --git a/README.md b/README.md
index 9ea65f4..94e20c4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,97 @@
-# bytom-kit
-kaleidoscope
+Bytom Kit
+==========
+
+- [1 Motivation](#1-motivation)
+- [2 Usage](#2-usage)
+  - [2.1 Key](#21-key)
+  - [2.2 Address](#22-address)
+  - [2.3 Sign](#23-sign)
+  - [2.4 Verify](#24-verify)
+  - [2.5 Submit Transaction](#25-submit-transaction)
+  - [2.6 Decode Raw Transaction](#26-decode-raw-transaction)
+  - [2.7 Testnet Faucet](#27-testnet-faucet)
+
+## 1 Motivation
+
+Bytom Kit is a simple tool which can help developer to understand Bytom easily. It contains 36 api for now:
+
+- sign
+- verify
+- create_entropy
+- entropy_to_mnemonic
+- mnemonic_to_seed
+- seed_to_root_xprv
+- xprv_to_expanded_private_key
+- xpub_to_public_key
+- xpub_verify
+- xprv_sign
+- xprv_to_xpub
+- xprv_to_child_xprv
+- xpub_to_child_xpub
+- create_P2WPKH_program
+- create_address
+- get_path_from_index
+- submit_transaction
+- create_qrcode_base64
+- create_new_key
+- create_new_address
+- decode_raw_transaction
+- get_gm_root_xprv
+- get_gm_xpub
+- get_gm_xprv
+- get_gm_public_key
+- get_gm_child_xprv
+- get_gm_child_xpub
+- gm_xpub_verify
+- gm_xprv_sign
+- get_gm_P2WPKH_program
+- get_gm_address
+- get_gm_new_key
+- get_gm_new_address
+- decode_raw_tx
+- get_testnet_coins
+- get_gm_testnet_coins
+
+## 2 Usage
+
+### 2.1 Key
+
+Link: <https://blockmeta.com/tools/key>
+
+![](./images/key.png)
+
+### 2.2 Address
+
+Link: <https://blockmeta.com/tools/address>
+
+![](./images/address.png)
+
+### 2.3 Sign
+
+Link: <https://blockmeta.com/tools/sign>
+
+![](./images/sign.png)
+
+### 2.4 Verify
+
+Link: <https://blockmeta.com/tools/verify>
+
+![](./images/verify.png)
+
+### 2.5 Submit Transaction
+
+Link: <https://blockmeta.com/tools/txs>
+
+![](./images/submit-tx.png)
+
+### 2.6 Decode Raw Transaction
+
+Link: <https://blockmeta.com/tools/decode>
+
+![](./images/decode-raw-tx.png)
+
+### 2.7 Testnet Faucet
+
+Link: <https://blockmeta.com/tools/faucet>
+
+![](./images/testnet-faucet.png)
\ No newline at end of file

diff --git a/images/address.png b/images/address.png
new file mode 100644 (file)
index 0000000..42f1316
Binary files /dev/null and b/images/address.png differ

diff --git a/images/decode-raw-tx.png b/images/decode-raw-tx.png
new file mode 100644 (file)
index 0000000..95fc260
Binary files /dev/null and b/images/decode-raw-tx.png differ

diff --git a/images/key.png b/images/key.png
new file mode 100644 (file)
index 0000000..79f9951
Binary files /dev/null and b/images/key.png differ

diff --git a/images/sign.png b/images/sign.png
new file mode 100644 (file)
index 0000000..29965d6
Binary files /dev/null and b/images/sign.png differ

diff --git a/images/submit-tx.png b/images/submit-tx.png
new file mode 100644 (file)
index 0000000..ef7eb69
Binary files /dev/null and b/images/submit-tx.png differ

diff --git a/images/testnet-faucet.png b/images/testnet-faucet.png
new file mode 100644 (file)
index 0000000..3b25a69
Binary files /dev/null and b/images/testnet-faucet.png differ

diff --git a/images/verify.png b/images/verify.png
new file mode 100644 (file)
index 0000000..942b6b9
Binary files /dev/null and b/images/verify.png differ