From 17dc3fb3b6b9c94ded99c672711d43677c4e2eca Mon Sep 17 00:00:00 2001
From: Dave Collins <davec@conformal.com>
Date: Wed, 9 Jul 2014 20:43:24 -0500
Subject: [PATCH] Really add READEME.md for bloom package.

---
 bloom/README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 bloom/README.md

diff --git a/bloom/README.md b/bloom/README.md
new file mode 100644
index 0000000..744a38d
--- /dev/null
+++ b/bloom/README.md
@@ -0,0 +1,40 @@
+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.  Package coinset is licensed under the liberal ISC license.
+
+## Documentation
+
+[![GoDoc](https://godoc.org/github.com/conformal/btcutil/bloom?status.png)]
+(http://godoc.org/github.com/conformal/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/conformal/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/conformal/btcutil/bloom
+
+## Installation
+
+```bash
+$ go get github.com/conformal/btcutil/bloom
+```
+
+## Examples
+
+* [NewFilter Example]
+  (http://godoc.org/github.com/conformal/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.