Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS-3656] docs: Update CDC terminology #158

Merged
merged 1 commit into from
Oct 25, 2024
Merged

[DOCS-3656] docs: Update CDC terminology #158

merged 1 commit into from
Oct 25, 2024

Conversation

jrodewig
Copy link
Contributor

Description

Updates the README's streaming section to use:

  • New CDC terminology (stream token -> event source)
  • New eventSource() and eventsOn() FQL methods

Motivation and context

This aligns the README with the latest terminology in the docs and FQL.

How was the change tested?

N/A

Screenshots (if appropriate):

Change types

    • Bug fix (non-breaking change that fixes an issue)
    • New feature (non-breaking change that adds functionality)
    • Breaking change (backwards-incompatible fix or feature)

Checklist:

    • My code follows the code style of this project.
    • My change requires a change to Fauna documentation.
    • My change requires a change to the README, and I have updated it accordingly.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@jrodewig jrodewig merged commit 8c3f4d4 into main Oct 25, 2024
1 check passed
@jrodewig jrodewig deleted the cdc-readme branch October 25, 2024 21:10
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.

2 participants