Skip to content

Commit 8583893

Browse files
committed
Status and credits
1 parent 26f3e53 commit 8583893

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,14 @@ add multiple **Patterns** to it, and then query JSON blobs
1919
called **Events** to discover which of the patterns match
2020
the fields in the event.
2121

22+
### Status
23+
24+
As of late May 2022, Quamina has a lot of unit tests and
25+
they're all passing. We are working on getting the
26+
GitHub-based CI/CD nailed down and stable. We have not
27+
pressed the “release” button, so we reserve the right
28+
to change APIs.
29+
2230
### Patterns
2331

2432
Consider the following JSON Event, taken from the example
@@ -187,8 +195,17 @@ features.
187195
```go
188196
func NewCoreMatcher() *Matcher
189197
```
198+
```go
199+
func pruner.NewMatcher() *Matcher
200+
```
201+
202+
Create new Matchers, take no arguments. The difference
203+
is that the `pruner.NewMatcher` version supports the
204+
`DeletePattern()` API. Be careful: It occasionally
205+
rebuilds the Matcher in stop-the-world fashion, so if you
206+
delete lots of Patterns in a large Matcher you may
207+
encounter occasional elevated latencies.
190208

191-
Creates a new Matcher, takes no arguments.
192209
```go
193210
func (m *Matcher) AddPattern(x X, patternJSON string) error
194211
```
@@ -284,4 +301,12 @@ From Wikipedia: Quamina Gladstone (1778 – 16 September
284301
Guyanese slave from Africa and father of Jack Gladstone.
285302
He and his son were involved in the Demerara rebellion
286303
of 1823, one of the largest slave revolts in the British
287-
colonies before slavery was abolished.
304+
colonies before slavery was abolished.
305+
306+
### Credits
307+
308+
@timbray: v1.0 and patches.
309+
310+
@jsmorph: `Pruner` and concurrency testing.
311+
312+
@embano1: CI/CD and project structure.

0 commit comments

Comments
 (0)