Skip to content

Refresh README for new matcher operators and faster onboarding#336

Merged
albe merged 3 commits into
mainfrom
copilot/update-readme-with-new-operators
Jul 18, 2026
Merged

Refresh README for new matcher operators and faster onboarding#336
albe merged 3 commits into
mainfrom
copilot/update-readme-with-new-operators

Conversation

Copilot AI commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

README now documents the newly added matcher operators and is reorganized to be easier to scan for common usage. The update focuses on first-contact clarity while preserving links to deeper docs.

  • Operator coverage update

    • Expanded matcher documentation to include array-containment operators: $has and $hasAny.
    • Updated feature summary language so supported operator capabilities are visible in the top-level feature table.
  • Entry-point readability

    • Introduced a clearer Quick Start anchor for immediate usage.
    • Added Common Usage at a Glance to surface the primary workflows (commit, getEventStream, query + DCB condition, fromStreams, createConsumer) without requiring full-doc navigation.
  • Matcher semantics clarification

    • Clarified that scalar operators can be combined with AND semantics on a field.
    • Clarified that $has / $hasAny are array-containment operators and should be used standalone per field.
{ payload: { amount: { $gte: 100, $lt: 1000 } } }
{ payload: { tags: { $has: 'featured' } } }
{ payload: { tags: { $hasAny: ['featured', 'priority'] } } }

Comment thread README.md Outdated
Copilot AI requested a review from albe July 18, 2026 13:24
Copilot finished work on behalf of albe July 18, 2026 13:24
@albe
albe marked this pull request as ready for review July 18, 2026 13:45
@coveralls

coveralls commented Jul 18, 2026

Copy link
Copy Markdown

Coverage Status

coverage: 98.299%. remained the same — copilot/update-readme-with-new-operators into main

@albe

albe commented Jul 18, 2026

Copy link
Copy Markdown
Owner

@copilot bump the package version to 1.4.0 in package.json and package-lock

Copilot AI commented Jul 18, 2026

Copy link
Copy Markdown
Contributor Author

@copilot bump the package version to 1.4.0 in package.json and package-lock

Done in 753597c: bumped the version to 1.4.0 in both package.json and package-lock.json.

Copilot finished work on behalf of albe July 18, 2026 13:50
@albe
albe merged commit 9bf24d2 into main Jul 18, 2026
8 checks passed
@albe
albe deleted the copilot/update-readme-with-new-operators branch July 18, 2026 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants