dcrd/bloom/README.md
Samarth Hattangady 4f023d7260 bloom: Fix link in README.
The link in the dcrd/bloom/README.md page led to a 'Not Found' page on
GoDoc. The link has now been changed.
2017-11-21 00:40:56 +05:30

26 lines
699 B
Markdown

bloom
=====
[![GoDoc](http://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/decred/dcrd/bloom)
Package bloom provides an API for dealing with decred-specific bloom filters.
A comprehensive suite of tests is provided to ensure proper functionality.
## Installation and Updating
```bash
$ go get -u github.com/decred/dcrd/bloom
```
## Examples
* [NewFilter Example](https://godoc.org/github.com/decred/dcrd/bloom#example-package--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.