OSDN Git Service

change the project readme file.
authorsuccessli <successli@outlook.com>
Mon, 25 Jun 2018 11:21:17 +0000 (19:21 +0800)
committersuccessli <successli@outlook.com>
Mon, 25 Jun 2018 11:21:17 +0000 (19:21 +0800)
README.md
utxomerger/README.md
utxomerger/config.yaml [deleted file]

index 24c52f9..4a8bbb7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,4 +13,35 @@ 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)
\ No newline at end of file
+## [btm-sender](https://github.com/Bytom/btm-spanner/blob/master/btmsender/README.md)
+
+## btm-merger
+
+This is a bytom tool that can merge some utxos to one.
+
+> btm-merger 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]
+
+Bytom merge utxo tool
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -o URL, --url URL     API url to connect
+  -a ACCOUNT_ALIAS, --account ACCOUNT_ALIAS
+                        account alias
+  -p PASSWORD, --pass PASSWORD
+                        account password
+  -x MAX_AMOUNT, --max MAX_AMOUNT
+                        range lower than max_amount
+  -s MIN_AMOUNT, --min MIN_AMOUNT
+                        range higher than min_amount
+  -l, --list            Show UTXO list without merge
+  -m MERGE_LIST, --merge MERGE_LIST
+                        UTXO to merge
+  -y, --yes             confirm transfer
+  ```
+
+> see more details in [btm-merger README.md](https://github.com/Bytom/btm-spanner/blob/master/btmsender/README.md) file.
\ No newline at end of file
index 80455c0..b362d9c 100644 (file)
@@ -19,7 +19,7 @@ Usage:
 
 Options:
   ```shell
-  usage: merge_utxo.py [-h] [-o URL] [-a ACCOUNT_ALIAS] [-p PASSWORD]
+  usage: python btmspanner.py utxomerger [-h] [-o URL] [-a ACCOUNT_ALIAS] [-p PASSWORD]
                      [-x MAX_AMOUNT] [-s MIN_AMOUNT] [-l] [-m MERGE_LIST] [-y]
 
 Bytom merge utxo tool
diff --git a/utxomerger/config.yaml b/utxomerger/config.yaml
deleted file mode 100644 (file)
index ec87a04..0000000
+++ /dev/null
@@ -1,31 +0,0 @@
-version: 1
-formatters:
-  brief:
-    format: "%(asctime)s - %(message)s"
-  simple:
-    format: "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
-handlers:
-  console:
-    class : logging.StreamHandler
-    formatter: brief
-    level   : INFO
-  file:
-    class : logging.FileHandler
-    formatter: simple
-    level: DEBUG
-    filename: debug.log
-  error:
-    class: logging.handlers.RotatingFileHandler
-    level: ERROR
-    formatter: simple
-    filename: error.log
-    maxBytes: 10485760
-    backupCount: 20
-    encoding: utf8
-loggers:
-  main.core:
-    level: DEBUG
-    handlers: [console, file, error]
-root:
-  level: DEBUG
-  handlers: [console]
\ No newline at end of file