From e6b5eced701d1724e309f39b2cb07c2ec150aaa3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Vin=C3=ADcius=20Garcia?= <vingarcia00@gmail.com>
Date: Wed, 12 Jul 2023 20:33:36 -0300
Subject: [PATCH] Add a code example to the doc string

---
 logger.go | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/logger.go b/logger.go
index 5755c56..e70c496 100644
--- a/logger.go
+++ b/logger.go
@@ -58,6 +58,23 @@ type loggerFn func(ctx context.Context, query string, params []interface{}, err
 // InjectLogger is a debugging tool that allows the user to force
 // KSQL to log the query, query params and error response whenever
 // a query is executed.
+//
+// Example Usage:
+//
+//     ctx = ksql.InjectLogger(ctx, ksql.Logger)
+//
+//     var user User
+//     db.Insert(ctx, usersTable, &user)
+//
+//     user.Name = "NewName"
+//     db.Patch(ctx, usersTable, &user)
+//
+//     var users []User
+//     db.Query(ctx, &users, someQuery, someParams...)
+//     db.QueryOne(ctx, &user, someQuery, someParams...)
+//
+//     db.Delete(ctx, usersTable, user.ID)
+//
 func InjectLogger(
 	ctx context.Context,
 	logFn LoggerFn,