diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a827cf5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ +MIT License + +Copyright (c) 2024 Omkar Patil + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..481648e --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +# BloomFilter + +[![Build Status](https://github.com/beastop/bloomfilter/actions/workflows/go.yml/badge.svg)](https://github.com/beastop/bloomfilter/actions) +[![GoDoc](https://pkg.go.dev/badge/github.com/beastop/bloomfilter.svg)](https://pkg.go.dev/github.com/beastop/bloomfilter) + +BloomFilter is a simple and efficient implementation of a Bloom filter in Go. + +## Installation + +To install the package, run: +```sh +go get github.com/beastop/bloomfilter +``` + +## Usage + +### Creating a Bloom Filter + +```go +package main + +import ( + "fmt" + "github.com/beastop/bloomfilter" +) + +func main() { + // Create a new Bloom filter + bloom, err := bloomfilter.New(100, 0.01) + if err != nil { + fmt.Println("Error:", err) + return + } + + // Add items to the Bloom filter + bloom.Add("foo") + bloom.Add("bar") + + // Check if items are in the Bloom filter + fmt.Println("foo in bloom filter:", bloom.Contains("foo")) + fmt.Println("baz in bloom filter:", bloom.Contains("baz")) +} +``` + +## Documentation + +For detailed API documentation, please visit the [GoDoc](https://pkg.go.dev/github.com/beastop/bloomfilter). + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.