Update README.

README

@@ -1,17 +0,0 @@
-
-This bloom filter implementation:
-1) Has a constructor that accepts a maximum comfortable number of members and maximum appropriate error (false positive) rate, and
-   derives the fiddly bits from that; most bloom filter modules ask the enduser to specify the fiddly bits themselves.
-2) Has a nice test suite, including checks for error rate.
-3) Is in pure Python that'll run on CPython 2.x, CPython 3.x, PyPy or Jython.
-4) Has a pair of simple, fast hash functions that give a good error rate - they're better than many of the alternatives.
-   They're not Murmur or Jenkins, but the tests strongly suggest that they're working well.
-5) Passes pylint and pep8.
-6) Supports adding elements, testing for membership, and'ing sets and or'ing sets.
-
-The code is derived from http://code.activestate.com/recipes/577686-bloom-filter/ and inherits that code's license (MIT).
-
-For more about Bloom Filters:
-http://en.wikipedia.org/wiki/Bloom_filter
-http://spyced.blogspot.com/2009/01/all-you-ever-wanted-to-know-about.html
-

README.md

@@ -0,0 +1,49 @@
+# bloom-filter
+
+This project builds on `drs-bloom-filter` and `bloom_filter_mod`.
+Credits and links can be found in AUTHORS.md.
+
+## Installation
+
+    pip install bloom_filter
+
+
+## Example:
+
+    from bloom_filter import BloomFilter
+
+    have_met = BloomFilter()
+
+    def have_i_met(name):
+        met = name in have_met
+        print('Have I met {} before: {}'.format(name, met))
+
+    def meet(name):
+        have_met.add(name)
+        print('Hello, {}'.format(name))
+
+    for name in ['Harry', 'Larry', 'Moe']:
+        have_i_met(name)
+        meet(name)
+        have_i_met(name)
+
+
+## Usage:
+
+    from bloom_filter import BloomFilter
+
+    # instantiate BloomFilter with custom settings,
+    # max_elements is how many elements you expect the filter to hold.
+    # error_rate defines accuracy; You can use defaults with
+    # `BloomFilter()` without any arguments. Following example
+    # is same as defaults:
+    bloom = BloomFilter(max_elements=10000, error_rate=0.1)
+
+    # Test whether the bloom-filter has seen a key:
+    assert "test-key" in bloom is False
+
+    # Mark the key as seen
+    bloom.add("test-key")
+
+    # Now check again
+    assert "test-key" in bloom is True