Skip to content

Commit

Permalink
doc: documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
Pho3b committed Dec 20, 2023
1 parent 3652cc0 commit e0a20da
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Logging with this library can be achieved in two main ways:
1. Using the Package Level Logger
2. Instantiating and using a new Logger struct

Both of them implement the same features and methods, it just depends on wether you need
Both of them implement the same features and methods, it just depends on whether you need
a new Logger instance struct or not.

### Package Logger
Expand All @@ -18,6 +18,7 @@ logs.Warn("my warning test") // stdout: 'WARN: my warning test'
logs.Info("my", "into", "test", 2) // stdout: 'INFO: my info test 2'
logs.Debug("hey", "check this", "debug") // stdout: 'DEBUG: hey check this debug'
logs.Error("here is the error") // stderr: 'ERROR: here is the error'
logs.Log(colors.Red, "Here is a Red Msg") // stdout: 'Here is a Red Msg' (Colored Red)
```

### Struct Logger
Expand All @@ -31,6 +32,7 @@ logger.Warn("my warning test") // stdout: 'WARN: my warning test'
logger.Info("my", "into", "test", 2) // stdout: 'INFO: my info test 2'
logger.Debug("hey", "check this", "debug") // stdout: 'DEBUG: hey check this debug'
logger.Error("here is the error") // stderr: 'ERROR: here is the error'
logger.Log(colors.Red, "Here is a Red Msg") // stdout: 'Here is a Red Msg' (Colored Red)
```

### Log Levels
Expand Down

0 comments on commit e0a20da

Please sign in to comment.