update readme

barrust · Jan 4, 2024 · fac75fe · fac75fe
1 parent ef8d798
commit fac75fe
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -131,6 +131,18 @@ Import pyprobables and setup a Cuckoo Filter
     cko.check('google.com')  # should return True
 
 
+Import pyprobables and setup a Quotient Filter
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code:: python
+
+    from probables import QuotientFilter
+    qf = QuotientFilter(quotient=24)
+    qf.add('google.com')
+    qf.check('facebook.com')  # should return False
+    qf.check('google.com')  # should return True
+
+
 Supplying a pre-defined, alternative hashing strategies
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^