e8bab6bc19
First, it removes the documentation section from all the README.md files and instead puts a web-based godoc badge and link at the top with the other badges. This is being done since the local godoc tool no longer ships with Go by default, so the instructions no longer work without first installing godoc. Due to this, pretty much everyone uses the web-based godoc these days anyways. Anyone who has manually installed godoc won't need instructions. Second, it makes sure the ISC license badge is at the top with the other badges and removes the textual reference in the overview section. Third, it's modifies the Installation section to Installation and Updating and adds a -u to the go get command since it works for both and thus is simpler. Finally, it replaces the badges with SVG versions from shields.io so they are consistent. |
||
|---|---|---|
| base58 | ||
| bloom | ||
| coinset | ||
| hdkeychain | ||
| txsort | ||
| .gitignore | ||
| .travis.yml | ||
| address.go | ||
| address_test.go | ||
| amount.go | ||
| amount_test.go | ||
| appdata.go | ||
| appdata_test.go | ||
| block.go | ||
| block_test.go | ||
| certgen.go | ||
| certgen_test.go | ||
| const.go | ||
| cov_report.sh | ||
| doc.go | ||
| example_test.go | ||
| goclean.sh | ||
| hash160.go | ||
| internal_test.go | ||
| LICENSE | ||
| net.go | ||
| net_noop.go | ||
| README.md | ||
| test_coverage.txt | ||
| tx.go | ||
| tx_test.go | ||
| wif.go | ||
| wif_test.go | ||
btcutil
[
]
(https://travis-ci.org/btcsuite/btcutil) [![Coverage Status]
(http://img.shields.io/coveralls/btcsuite/btcutil.svg)]
(https://coveralls.io/r/btcsuite/btcutil?branch=master) ![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)
[
]
(http://godoc.org/github.com/btcsuite/btcutil)
Package btcutil provides bitcoin-specific convenience functions and types.
A comprehensive suite of tests is provided to ensure proper functionality. See
test_coverage.txt for the gocov coverage report. Alternatively, if you are
running a POSIX OS, you can run the cov_report.sh script for a real-time
report.
This package was developed for btcd, an alternative full-node implementation of bitcoin which is under active development by Conformal. Although it was primarily written for btcd, this package has intentionally been designed so it can be used as a standalone package for any projects needing the functionality provided.
Installation and Updating
$ go get -u github.com/btcsuite/btcutil
GPG Verification Key
All official release tags are signed by Conformal so users can ensure the code has not been tampered with and is coming from the btcsuite developers. To verify the signature perform the following:
-
Download the public key from the Conformal website at https://opensource.conformal.com/GIT-GPG-KEY-conformal.txt
-
Import the public key into your GPG keyring:
gpg --import GIT-GPG-KEY-conformal.txt -
Verify the release tag with the following command where
TAG_NAMEis a placeholder for the specific tag:git tag -v TAG_NAME
License
Package btcutil is licensed under the copyfree ISC License.