From c7a3d0a3700ecadbddb4513106f8cbe57eb938b7 Mon Sep 17 00:00:00 2001 From: John Chi Date: Mon, 25 Jun 2018 19:12:50 +0800 Subject: [PATCH] docs(readme): modify project readme --- README.md | 16 +++++++++++++++- btmsender/README.md | 18 +++--------------- btm.txt => btmsender/btm.txt | 0 3 files changed, 18 insertions(+), 16 deletions(-) rename btm.txt => btmsender/btm.txt (100%) diff --git a/README.md b/README.md index 4d54921..24c52f9 100644 --- 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 diff --git a/btmsender/README.md b/btmsender/README.md index 5aa5aa5..a959785 100644 --- a/btmsender/README.md +++ b/btmsender/README.md @@ -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: diff --git a/btm.txt b/btmsender/btm.txt similarity index 100% rename from btm.txt rename to btmsender/btm.txt -- 2.11.0