lbcutil/bloom/README.md

bloom
=====

[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)

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.

## Examples

* [NewFilter Example](http://godoc.org/github.com/lbryio/lbcutil/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.
Really add READEME.md for bloom package. 2014-07-10 03:43:24 +02:00			`bloom`
			`=====`

multi: Update markdown files for GFM changes. 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. 2017-05-25 19:56:27 +02:00			`[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)`
Add TravisCI build status badge to subpackages. 2014-07-10 03:47:04 +02:00
Really add READEME.md for bloom package. 2014-07-10 03:43:24 +02:00			`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
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-24 00:10:35 +02:00			`report.`
Really add READEME.md for bloom package. 2014-07-10 03:43:24 +02:00
			`## Examples`

renamed package to lbcutil, updated refs to it 2021-09-10 22:30:39 +02:00			`* [NewFilter Example](http://godoc.org/github.com/lbryio/lbcutil/bloom#example-NewFilter)`
Really add READEME.md for bloom package. 2014-07-10 03:43:24 +02:00			`Demonstrates how to create a new bloom filter, add a transaction hash to it,`
renamed package to lbcutil, updated refs to it 2021-09-10 22:30:39 +02:00			`and check if the filter matches the transaction.`