Update README.md #205
Merged
Update README.md #205
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
Signed-off-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
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.
This pull request updates the
README.mdfile to include new sections documenting additional packages and utilities in the project. These changes improve the documentation by providing detailed descriptions of newly added packages and updating existing ones.New package documentation:
debug: Added a section describing debug server utilities for exposing runtime information and debugging endpoints.kv: Added a section for a consolidated package managing Redis/Valkey clients with Sentinel support, TLS configuration, and OpenTelemetry instrumentation.must: Documented utility functions for handling errors in initialization code where panicking is appropriate.queue: Added a description of a Redis streams-based queue implementation with shuffle-sharding for tenant isolation and workload distribution.shuffleshard: Documented the implementation of shuffle sharding for workload distribution across multiple instances.Updates to existing package documentation:
logging: Updated to reflect the use ofgo.uber.org/zapfor logging conventions instead ofgithub.com/sirupsen/logrus.