diff --git a/README.md b/README.md new file mode 100644 index 0000000..88a4c15 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ + +Common library for the NTP Pool project with shared infrastructure components. + +## Packages + +- **apitls** - TLS setup for NTP Pool internal services with embedded CA +- **config** - NTP Pool project configuration with environment variables +- **ekko** - Enhanced Echo web framework with observability middleware +- **health** - Standalone health check HTTP server +- **kafka** - Kafka client wrapper with TLS support +- **logger** - Structured logging with OpenTelemetry integration +- **metricsserver** - Prometheus metrics HTTP server +- **timeutil** - JSON-serializable duration types +- **tracing** - OpenTelemetry distributed tracing setup +- **types** - Shared data structures for NTP Pool +- **ulid** - Thread-safe ULID generation +- **version** - Build metadata and version information +- **xff/fastlyxff** - Fastly CDN IP range management + +[![Go Reference](https://pkg.go.dev/badge/go.ntppool.org/common.svg)](https://pkg.go.dev/go.ntppool.org/common)