OSDN Git Service

docs(readme): modify project readme
[bytom/bytom-spanner.git] / README.md
index 4d54921..24c52f9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,16 @@
-# btm-tools
+# btm-spanner
 Python based Bytom wallet tools
+
+Requirements: Python 3.x, with requests package
+
+Dependencies:
+   ```
+    pip install requests
+   ```
+Prepare:
+   ```
+    bytomd init --chain_id mainnet
+   ```
+   If you don't know how to run bytomd please check this [wiki](https://github.com/Bytom/bytom/wiki/Build-and-Install)
+
+## [btm-sender](https://github.com/Bytom/btm-spanner/blob/master/btmsender/README.md)
\ No newline at end of file