From 422098e4a2665b62b23061c9f75bbd48d6a19404 Mon Sep 17 00:00:00 2001
From: John Harris <john.harris@nexusmods.com>
Date: Wed, 12 Jul 2023 10:53:15 +0100
Subject: [PATCH] docs: update docs since module rename

---
 README.md | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index c8ead59..a7dd5b4 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
 ```
-- 
GitLab