fac8a9a582
The github markdown interpreter has been changed such that it no longer allows spaces in between the brackets and parenthesis of links. This updates all of the markdown files accordingly. While here, it also corrects a couple of inconsistencies in regards to other README.md files in the project.
30 lines
1 KiB
Markdown
30 lines
1 KiB
Markdown
bloom
|
|
=====
|
|
|
|
[](https://travis-ci.org/btcsuite/btcutil)
|
|
[](http://copyfree.org)
|
|
[](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
|
|
|
|
```bash
|
|
$ go get -u github.com/btcsuite/btcutil/bloom
|
|
```
|
|
|
|
## Examples
|
|
|
|
* [NewFilter Example](http://godoc.org/github.com/btcsuite/btcutil/bloom#example-NewFilter)
|
|
Demonstrates how to create a new bloom filter, add a transaction hash to it,
|
|
and check if the filter matches the transaction.
|
|
|
|
## License
|
|
|
|
Package bloom is licensed under the [copyfree](http://copyfree.org) ISC
|
|
License.
|