From 37418ffeb6593c7bbe3e165d952d7870a43a7479 Mon Sep 17 00:00:00 2001 From: Simon Cornet Date: Thu, 6 Mar 2025 12:06:44 +0100 Subject: [PATCH] docs: improved readme --- readme.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index 90e182a..6b31a1c 100644 --- a/readme.md +++ b/readme.md @@ -12,8 +12,7 @@ logger.SetDebug(true) # optional; default false # Usage examples ``` logger.Print("Simple log message withouth error", nil) -logger.Fatal("Fatal log message with error", err) - +logger.Fatal("Fatal log message with error and exits the program", err) ``` Will be printed like this: ``` @@ -24,5 +23,5 @@ Will be printed like this: # Return functions ``` -logger.GetAppName() will return the current used app name as a string. -logger.GetDebug() will return the current debug setting as a bool. +logger.GetAppName() # will return the current used app name as a string. +logger.GetDebug() # will return the current debug setting as a bool.