OSDN Git Service

docs(readme): modify project readme
authorJohn Chi <john@8btc-1s-MBP.localdomain>
Mon, 25 Jun 2018 11:12:50 +0000 (19:12 +0800)
committerJohn Chi <john@8btc-1s-MBP.localdomain>
Mon, 25 Jun 2018 11:12:50 +0000 (19:12 +0800)
README.md
btmsender/README.md
btmsender/btm.txt [moved from btm.txt with 100% similarity]

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
index 5aa5aa5..a959785 100644 (file)
@@ -1,21 +1,9 @@
-# btm spanner
-
-Requirements: Python 3.x, with requests package
-
-Dependencies:
-   ```
-    pip install requests
-   ```
+# btm-sender
 
 Usage:
    ```
-    ./bytomd init --chain_id mainnet
+    btmspanner.py btmsender [options]
    ```
-   ```
-    ./btmspanner.py [options]
-   ```
-   If you don't know how to run bytomd please check this [wiki](https://github.com/Bytom/bytom/wiki/Build-and-Install)
-
 Options:
    ```
   -h, --help      show this help message and exit
@@ -27,7 +15,7 @@ Options:
 
 Example:
    ```
-    ./btmspanner.py -i ./btm.txt -a 0F0BV1OLG0A04 -p 123456 -c 1000
+    btmspanner.py btmsender -i btmsender/btm.txt -a 0F0BV1OLG0A04 -p 123456 -c 1000
    ```
 
 Transaction txt file format:
similarity index 100%
rename from btm.txt
rename to btmsender/btm.txt