Update for OpenRiak

.github/workflows/erlang.yml

@@ -3,10 +3,10 @@ name: Erlang CI
 on:
   push:
     branches:
-      - nhse-develop
+      - openriak-3.2
   pull_request:
     branches:
-      - nhse-develop
+      - openriak-3.2
 
 jobs:
 

README.md

@@ -0,0 +1,47 @@
+# ebloom
+
+## Overview
+
+![ebloom OpenRiak Status](https://github.com/OpenRiak/ebloom/actions/workflows/erlang.yml/badge.svg?branch=openriak-3.2)
+
+`ebloom` is a NIF wrapper around a basic bloom filter.
+
+## Quick Start
+
+You must have [[http://erlang.org/download.html][Erlang/OTP 22]] or later and a GNU-style build system to compile and run =ebloom=.
+
+```
+git clone git://github.com/basho/ebloom.git
+cd ebloom
+make
+```
+
+Start up an Erlang shell with the path to =ebloom= included.
+
+```
+erl -pa path/to/ebloom/ebin
+```
+
+Create a new bloom filter, insert elements, and test for an elements presence.
+
+```
+1> PredictedElementCount=5.
+5
+2> FalsePositiveProbability=0.01.
+
+3> RandomSeed=123.
+123
+4> {ok, Ref} = ebloom:new(PredictedElementCount, FalsePositiveProbability, RandomSeed).
+{ok,<<>>}
+5> ebloom:insert(Ref, <<"abcdef">>).
+ok
+6> true = ebloom:contains(Ref, <<"abcdef">>).
+true
+7> false = ebloom:contains(Ref, <<"zzzzzz">>).
+false
+```
+
+## Contributing
+
+The `ebloom` module is maintained to support a single function within the Riak legacy replication feature.  It is not actively developed (i.e. to consider new features or performance improvements).
+

rebar.config

@@ -8,7 +8,7 @@
 {erl_opts, [debug_info, warnings_as_errors]}.
 {cover_enabled, true}.
 
-{plugins, [{pc, {git, "https://github.com/blt/port_compiler", {tag, "v1.14.0"}}}]}.
+{plugins, [{pc, {git, "https://github.com/OpenRiak/port_compiler", {tag, "openriak-3.2"}}}]}.
 
 {profiles, [
     {gha, [{erl_opts, [{d, 'GITHUBEXCLUDE'}]}]}