lbcutil/bloom/README.md
2015-01-15 21:35:29 -06:00

1.4 KiB

bloom

[Build Status] (https://travis-ci.org/btcsuite/btcutil)

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. Package coinset is licensed under the liberal ISC license.

Documentation

[GoDoc] (http://godoc.org/github.com/btcsuite/btcutil/bloom)

Full go doc style documentation for the project can be viewed online without installing this package by using the GoDoc site here: http://godoc.org/github.com/btcsuite/btcutil/bloom

You can also view the documentation locally once the package is installed with the godoc tool by running godoc -http=":6060" and pointing your browser to http://localhost:6060/pkg/github.com/btcsuite/btcutil/bloom

Installation

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

Examples

License

Package bloom is licensed under the copyfree ISC License.