diff --git a/README.md b/README.md index c8ead59632473b5752d6f6d157d2794c1558c3be..a7dd5b459427c86eb98ade86e11894ea623f7862 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,19 @@ # slog -Go module for structured logging. +Go module for nexus telemetry. + +Initially contains a logger, but expected to contain mechanisms for timing and metrics in future. + +## Components + +### logger Configures a logger with a JSON formatter using a schema suitable for datadog log ingestion. -## Example usage +## Development -Initialise and use the logger: +Run tests with: ``` -go run src/main/main.go +go test ```