Add installation to README

andrewdalpino · Oct 15, 2024 · 8a26f5e · 8a26f5e
1 parent 7b2b37b
commit 8a26f5e
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -6,6 +6,13 @@ An implementation of the OkBloomer algorithm, an autoscaling [Bloom filter](http
 - **Bounded** maximum false positive rate
 - **Open-source** and free to use commercially
 
+## Installation
+Install Ok Bloomer using a Python package manager, example pip:
+
+```
+pip install okbloomer
+```
+
 ### Parameters
 | # | Name | Default | Type | Description |
 |---|---|---|---|---|

diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "OkBloomer"
-version = "0.0.1"
+version = "0.0.2"
 requires-python = ">= 3.10"
 dependencies = [
   "mmh3>5.0.0",

diff --git a/src/okbloomer/__init__.py b/src/okbloomer/__init__.py
@@ -5,7 +5,7 @@
     BloomFilter,
 )
 
-__version__ = '0.0.1'
+__version__ = '0.0.2'
 
 __all__ = [
     'BloomFilter',