From 30c9685b33348e0560662640b8dee3dbf9332812 Mon Sep 17 00:00:00 2001
From: Gerard Vanloo <gvanloo@redhat.com>
Date: Thu, 14 Apr 2022 11:01:42 -0400
Subject: [PATCH] Updating documentation

---
 MIGRATION.md |  2 +-
 README.md    | 15 ++++++++++-----
 2 files changed, 11 insertions(+), 6 deletions(-)

diff --git a/MIGRATION.md b/MIGRATION.md
index 2ee30e0..521afea 100644
--- a/MIGRATION.md
+++ b/MIGRATION.md
@@ -15,7 +15,7 @@ import (
     "github.com/ViaQ/logerr/v2/log"
 )
 
-logger := log.NewLogger("", nil)
+logger := log.NewLogger("example-logger")
 
 logger.Info("Now logging info message")
 logger.Error(errors.New("New error"), "Now logging new error")
diff --git a/README.md b/README.md
index 16a8a00..a09bc79 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,8 @@ logger.V(1).Info("This logger's level has been raised by 1.")
 logger.V(5).Info("This logger's level has been raised by 5.")
 ```
 
+_Note: The `V` method is always additive. So logger.V(1).V(1) has a logger level of 2 instead of 1._
+
 Every log has a verbosity, which is controlled by the internal logging mechanism `logr.Sink`.
 
 Logs are recorded in two scenarios:
@@ -51,14 +53,17 @@ _Note: As mentioned above, with no concept of an "error" log, there is no error
 Logger Types:
 
 ```golang
-logger := log.NewLogger("")
-logger.Info("The default logger. Log verbosity is 0. Logs are written to stdout.")
+logger := log.NewLogger("default-logger")
+logger.Info("Log verbosity is 0. Logs are written to stdout.")
 
 buffer := bytes.NewBuffer(nil)
-options := log.Options{Writer:buffer, LogLevel: 1}
+options := log.Options{
+    log.WithOutput(buffer),
+    log.WithVerbosity(1)
+}
 
-optionLogger := log.NewLogger("", options)
-optionLogger.Info("Logger with options. Log verbosity is 1. Logs are written to byte buffer.")
+newLogger := log.NewLogger("customized-logger", options)
+newLogger.Info("Log verbosity is 1. Logs are written to byte buffer.")
 ```
 
 As mentions, the `Sink` will transform messages into JSON logs. Key/value information that is included in the message is also included in the log.