OSDN Git Service

change the project readme file.
[bytom/bytom-spanner.git] / README.md
index e0810a1..f862d20 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,17 +13,34 @@ Prepare:
    ```
    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)
+## btm-sender
 
+Bytom tool send BTM to large numbers of address
+
+Usage:
+   ```
+    btmspanner.py btmsender [-h] -i I -a A -p P [-c C]
+   ```
+Options:
+   ```
+  -h, --help      show this help message and exit
+  -i input        transaction txt file
+  -a account      wallet account id
+  -p password     wallet account password
+  -c count        transaction output count
+  ```
+See more details in btm-sender [README.md](https://github.com/Bytom/btm-spanner/blob/master/btmsender/README.md) file.
 ## utxo-merger
 
-This is a bytom tool that can merge some utxos to one.
+Bytom tool merge some utxos to one.
 
-> utxo-merger Usage:
+Usage:
   
   ```shell
-python btmspanner.py utxomerger [-h] [-o URL] [-a ACCOUNT_ALIAS] [-p PASSWORD]
-                     [-x MAX_AMOUNT] [-s MIN_AMOUNT] [-l] [-m MERGE_LIST] [-y]
+  $ python btmspanner.py utxomerger -h
+usage: btmspanner.py [-h] [-o URL] [-a ACCOUNT_ALIAS] [-p PASSWORD]
+                     [-x MAX_AMOUNT] [-s MIN_AMOUNT] [-l] [-m MERGE_LIST]
+                     [-f FOR_LOOP] [-y]
 
 Bytom merge utxo tool
 
@@ -41,7 +58,10 @@ optional arguments:
   -l, --list            Show UTXO list without merge
   -m MERGE_LIST, --merge MERGE_LIST
                         UTXO to merge
+  -f FOR_LOOP, --forloop FOR_LOOP
+                        size for loop of UTXO to merge
   -y, --yes             confirm transfer
+  
   ```
 
-> see more details in [utxo-merger README.md](https://github.com/Bytom/btm-spanner/blob/master/utxomerger/README.md) file.
\ No newline at end of file
+See more details in utxo-merger [README.md](https://github.com/Bytom/btm-spanner/blob/master/utxomerger/README.md) file.
\ No newline at end of file