lbcutil/bloom
Dave Collins e8bab6bc19 docs: Make various README.md files consistent.
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.
2015-10-23 17:17:38 -05:00
..
cov_report.sh Cleanup and finish BIP0037 bloom filter API. 2014-07-09 13:28:58 -05:00
example_test.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
filter.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
filter_test.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
merkleblock.go Return matched tx indices from NewMerkleBlock. 2015-07-28 04:02:49 -05:00
merkleblock_test.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
murmurhash3.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
murmurhash3_test.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
README.md docs: Make various README.md files consistent. 2015-10-23 17:17:38 -05:00
test_coverage.txt Update test coverage report. 2014-09-01 21:16:08 -05:00

bloom

[Build Status] (https://travis-ci.org/btcsuite/btcutil) ![ISC License] (http://img.shields.io/badge/license-ISC-blue.svg) [GoDoc] (http://godoc.org/github.com/btcsuite/btcutil/bloom)

Package bloom provides an API for dealing with bitcoin-specific bloom filters.

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.

Installation and Updating

$ go get -u github.com/btcsuite/btcutil/bloom

Examples

License

Package bloom is licensed under the copyfree ISC License.