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.
33 lines
1.1 KiB
Markdown
33 lines
1.1 KiB
Markdown
bloom
|
|
=====
|
|
|
|
[]
|
|
(https://travis-ci.org/btcsuite/btcutil) [![ISC License]
|
|
(http://img.shields.io/badge/license-ISC-blue.svg)](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.
|