Skip to content

Commit 96da25e

Browse files
author
shadowy-pycoder
committed
updated documentation
1 parent 0b3ded0 commit 96da25e

File tree

3 files changed

+23
-3
lines changed

3 files changed

+23
-3
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
11
Bitcoin Message Tool
22
======
33

4-
Bitcoin message signing/verification tool
4+
Bitcoin Message Tool
55

66
A lightweight CLI tool for signing and verification of bitcoin messages.
77
Bitcoin message is the most straightforward and natural way to prove ownership over
88
a given address without revealing any confidential information.
99

10+
This tool closely follows specification described in BIP137:
11+
12+
Please note that "since this format includes P2PKH keys, it is backwards compatible,
13+
but keep in mind some software has checks for ranges of headers and will report the newer
14+
segwit header types as errors."
15+
16+
More info: https://github.com/bitcoin/bips/blob/master/bip-0137.mediawiki
17+
1018
Installation
1119
------------
1220

bitcoin_message_tool/bmt.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
11
"""
22
Bitcoin Message Tool by shadowy-pycoder 2023
3+
34
A lightweight CLI tool for signing and verification of bitcoin messages.
45
Bitcoin message is the most straightforward and natural way to prove ownership over
56
a given address without revealing any confidential information.
67
8+
This tool closely follows specification described in BIP137:
9+
10+
Please note that "since this format includes P2PKH keys, it is backwards compatible,
11+
but keep in mind some software has checks for ranges of headers and will report the newer
12+
segwit header types as errors."
13+
14+
More info: https://github.com/bitcoin/bips/blob/master/bip-0137.mediawiki
15+
16+
17+
18+
719
Usage:
820
921
python -m bitcoin_message_tool -h

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@
2626
long_description=long_description,
2727
long_description_content_type="text/markdown",
2828
license="MIT",
29-
packages=find_packages(where="src"),
30-
package_dir={"": "src"},
29+
packages=find_packages(where="bitcoin_message_tool"),
30+
package_dir={"": "bitcoin_message_tool"},
3131
test_suite="tests",
3232
install_requires=[],
3333
keywords="",

0 commit comments

Comments
 (0)