# Petal 🌺

![tests](https://github.com/jamesduncombe/petal/workflows/tests/badge.svg)

Petal is a [Bloom filter](https://en.wikipedia.org/wiki/Bloom_filter) in Elixir.

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc).

## TODO

- ~~Abstract out the hashes so that additional hashes can be used~~
- ~~Add further tests~~
- ~~Add configurable bitfield length~~
- Potentially add a network interface to it
- ~~Add Dialyxir~~