Repository navigation
docs: say when to use it, and when something else fits better - #72
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a "When to use it, and when not" section to the README and the docs home page.
It says what omni-box is for (async Python 3.12+, PostgreSQL through SQLAlchemy, Kafka, outbox and inbox from one library, per-key order across relays) and names the better fit for the other cases: django-outbox-pattern and django-jaiminho on Django, faststream-outbox for FastStream users and non-Kafka brokers, CDC when Debezium is already there, eventsourcing for event sourcing, and custom repositories for Python below 3.12 or other databases.
Type of change
Checklist
zensical build --cleanpasses locally, no warnings