Fixed errors in the documentation

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) <year> <copyright holders>
+Copyright (c) 2023 Larv IT AB
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -2,7 +2,7 @@
 
 ## Installation
 
-`go get -u https://gitea.larvit.se/pwrpln/go_log`
+`go get -u gitea.larvit.se/pwrpln/go_log`
 
 ## Example usage
 
@@ -12,8 +12,7 @@ Most basic usage with default settings:
 import "gitea.larvit.se/pwrpln/go_log"
 
 func main() {
-	log := go_log.Log{}
-	log.SetDefaultValues{}
+	log := go_log.GetLog()
 	log.Error("Apocalypse! :O"); // stderr
 	log.Warn("The chaos is near"); // stderr
 	log.Info("All is well, but this message is important"); // stdout
@@ -27,8 +26,8 @@ func main() {
 Set log level:
 
 ```go
-log := go_log.Log{MinLogLvl: go_log.Debug}
-log.SetDefaultValues{}
+log := go_log.GetLog()
+log.MinLogLvl = go_log.Debug
 
 // Will now show on stdout
 log.Debug("A lot of detailed logs to debug your application");
@@ -45,8 +44,7 @@ log.Info("My log msg", "foo", "bar")
 Setting a logging context to prepend metadata on all log entries:
 
 ```go
-log := go_log.Log{}
-log.SetDefaultValues{}
+log := go_log.GetLog()
 log.Context = []interface{{"some", "thing"}}
 
 log.Info("A message")
@@ -59,14 +57,21 @@ log.Info("Zep", "other", "stuff")
 All available options, and their defaults:
 
 ```go
-loc, _ := time.LoadLocation("UTC")
+loc, _ := time.LoadLocation("UTC") // See more info at https://pkg.go.dev/time#LoadLocation
 log := go_log.Log{
-	Context:      []interface{},        // Will be prepended to metadata on all log entries
-	MinLogLvl:    go_log.Info,          // Minimal log level to output
-	Fmt:          go_log.DefaultFmt,    // Log message formatter
-	Stderr:       go_log.DefaultStderr, // Log message outputter for Debug, Verbose and Info
-	Stdout:       go_log.DefaultStdout, // Log message outputter for Warning and Error
-	TimeLocation: loc,                  // Timestamp location/time zone setting
+	Context:      []interface{}{},                // Will be prepended to metadata on all log entries
+	MinLogLvl:    go_log.LogLvlFromStr("Info"), // Minimal log level to output
+	Fmt:          go_log.DefaultFmt,            // Log message formatter
+	Stderr:       go_log.DefaultStderr,         // Log message outputter for Debug, Verbose and Info
+	Stdout:       go_log.DefaultStdout,         // Log message outputter for Warning and Error
+	TimeLocation: loc,                          // Timestamp location/time zone setting
 }
-// Don't run log.SetDefaultValues{} since it will override your settings
+```
+
+Or change them after initialization like this:
+
+```go
+log := go_log.GetLog()
+log.MinLogLvl = go_log.LogLvlFromStr("Debug")
+log.Context = []interface{}{"key1", "value1", "key2", "value2"}
 ```

go.mod

@@ -2,7 +2,7 @@ module gitea.larvit.se/pwrpln/go_log
 
 go 1.19
 
-require github.com/stretchr/testify v1.8.0
+require github.com/stretchr/testify v1.8.1
 
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect

go.sum

@@ -5,9 +5,11 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
+github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
 github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.8.0 h1:pSgiaMZlXftHpm5L7V1+rVB+AZJydKsMxsQBIJw4PKk=
 github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
+github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
+github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

main.go

@@ -35,6 +35,22 @@ type Log struct {
 	TimeLocation *time.Location // Timestamp location/time zone setting
 }
 
+func LogLvlFromStr(logLvl string) LogLvl {
+	if logLvl == "Error" {
+		return Error
+	} else if logLvl == "Warn" {
+		return Warn
+	} else if logLvl == "Info" {
+		return Info
+	} else if logLvl == "Verbose" {
+		return Verbose
+	} else if logLvl == "Debug" {
+		return Debug
+	} else {
+		return 0
+	}
+}
+
 func LogName(logLvl LogLvl) string {
 	if logLvl == 0 {
 		return "Error"
@@ -95,14 +111,16 @@ func DefaultStdout(msg string) {
 	os.Stdout.WriteString(msg)
 }
 
-func (log *Log) SetDefaultValues() {
-	if log.MinLogLvl == 0 {
-		log.MinLogLvl = 3
+func GetLog() Log {
+	log := Log{
+		Fmt:       DefaultFmt,
+		MinLogLvl: Info,
+		Stderr:    DefaultStderr,
+		Stdout:    DefaultStdout,
 	}
-	log.Fmt = DefaultFmt
-	log.Stderr = DefaultStderr
-	log.Stdout = DefaultStdout
 	log.TimeLocation, _ = time.LoadLocation("UTC")
+
+	return log
 }
 
 func (log *Log) Error(parts ...interface{}) {

main_test.go

@@ -9,8 +9,7 @@ import (
 func TestDefault(t *testing.T) {
 	stdout := ""
 	stderr := ""
-	testLog := Log{}
-	testLog.SetDefaultValues()
+	testLog := GetLog()
 	testLog.Stdout = func(msg string) {
 		stdout += msg
 	}
@@ -29,8 +28,7 @@ func TestDefault(t *testing.T) {
 
 func TestError(t *testing.T) {
 	stderr := ""
-	testLog := Log{}
-	testLog.SetDefaultValues()
+	testLog := GetLog()
 	testLog.Stderr = func(msg string) {
 		stderr += msg
 	}
@@ -38,16 +36,15 @@ func TestError(t *testing.T) {
 	assert.Equal(t, "[\x1b[31mErr\x1b[0m] lureri\n", stderr[20:])
 }
 
-func TestMetadata(t *testing.T) {
-	testLog := Log{}
-	testLog.SetDefaultValues()
-	testLog.Context = []interface{}{
-		"foo", "bar",
-		"lur", "pelle",
-	}
-	testLog.Info("bosse")
-	testLog.Error("frasse", "wat", ":O")
-}
+// func TestMetadata(t *testing.T) {
+// 	testLog := GetLog()
+// 	testLog.Context = []interface{}{
+// 		"foo", "bar",
+// 		"lur", "pelle",
+// 	}
+// 	testLog.Info("bosse")
+// 	testLog.Error("frasse", "wat", ":O")
+// }
 
 // func TestWoo(t *testing.T) {
 // 	loc, _ := time.LoadLocation("UTC")