Skip to content

Commit b69e565

Browse files
authored
Update README.md (#205)
* Update README.md * chore: update readme Signed-off-by: Mark Phelps <[email protected]> --------- Signed-off-by: Mark Phelps <[email protected]>
1 parent 70b0de2 commit b69e565

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ applications.
1717
A redis-backed typed object cache implementation supporting serve-from-stale and
1818
asynchronous cache fills.
1919

20+
### `debug`
21+
22+
Debug server utilities for exposing runtime information and debugging endpoints.
23+
2024
### `errors`
2125

2226
Configures conventions for recording errors: a wrapper around the Sentry SDK.
@@ -30,22 +34,48 @@ Feature flagging functions: a thin wrapper around the LaunchDarkly client.
3034
Conventions for creating HTTP clients with appropriate pooling and timeout
3135
configuration. Heavily inspired by <https://github.com/hashicorp/go-cleanhttp>.
3236

37+
### `kv`
38+
39+
Consolidated package for Redis/Valkey client management with Sentinel support,
40+
TLS configuration, and automatic OpenTelemetry instrumentation.
41+
3342
### `lock`
3443

3544
A redis-backed distributed lock for coordination within multi-instance services.
3645

3746
### `logging`
3847

39-
Configures logging conventions for `github.com/sirupsen/logrus`.
48+
Configures logging conventions using [go.uber.org/zap](https://github.com/uber-go/zap).
49+
50+
### `must`
51+
52+
Utility functions for handling errors in initialization code where panicking is appropriate.
53+
54+
### `queue`
55+
56+
Redis streams-based queue implementation with shuffle-sharding for tenant isolation
57+
and workload distribution.
4058

4159
### `ratelimit`
4260

4361
A redis-backed token-bucket rate limiter implementation.
4462

63+
### `shuffleshard`
64+
65+
Implementation of shuffle sharding for distributing workloads across multiple instances.
66+
4567
### `telemetry`
4668

4769
Standard OpenTelemetry configuration and tracer creation.
4870

71+
### `types`
72+
73+
Common type definitions and utilities including custom duration parsing and pointer helpers.
74+
75+
### `uuid`
76+
77+
UUID generation utilities with support for UUIDv7 (time-ordered UUIDs).
78+
4979
### `version`
5080

5181
A convention for retrieving service version from the environment.

0 commit comments

Comments
 (0)