Skip to content

Commit 7db33ec

Browse files
committed
chg: [doc] updated
1 parent 1220df6 commit 7db33ec

1 file changed

Lines changed: 14 additions & 6 deletions

File tree

README.rst renamed to README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
pybloom
2-
=======
1+
# pybloom
32

4-
This fork includes various fixes and enhancement available in various places.
3+
[![Python package](https://github.com/adulau/python-bloomfilter/actions/workflows/pythonpackage.yml/badge.svg)](https://github.com/adulau/python-bloomfilter/actions/workflows/pythonpackage.yml)
54

6-
.. image:: https://travis-ci.org/jaybaird/python-bloomfilter.svg?branch=master
7-
:target: https://travis-ci.org/jaybaird/python-bloomfilter
5+
This fork includes various fixes and enhancement available in various places.
86

97
``pybloom`` is a module that includes a Bloom Filter data structure along with
108
an implementation of Scalable Bloom Filters as discussed in:
@@ -22,8 +20,16 @@ is reached a new filter is then created exponentially larger than the last
2220
with a tighter probability of false positives and a larger number of hash
2321
functions.
2422

25-
.. code-block:: python
23+
## Installation
24+
25+
~~~~
26+
pip3 install -r requirements.txt
27+
pip3 install .
28+
~~~~
2629

30+
## Usage
31+
32+
~~~~python
2733
>>> from pybloom import BloomFilter
2834
>>> f = BloomFilter(capacity=1000, error_rate=0.001)
2935
>>> [f.add(x) for x in range(10)]
@@ -62,3 +68,5 @@ functions.
6268
# len(sbf) may not equal the entire input length. 0.01% error is well
6369
# below the default 0.1% error threshold. As the capacity goes up, the
6470
# error will approach 0.1%.
71+
72+
~~~~

0 commit comments

Comments
 (0)