From 121a2fa16659195e8f00333aeef6d072f3343122 Mon Sep 17 00:00:00 2001 From: 8ctopus Date: Mon, 20 Mar 2023 15:21:08 +0400 Subject: [PATCH] Cleanup readme --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 424b6b6..bfb9510 100644 --- a/README.md +++ b/README.md @@ -40,14 +40,18 @@ This simple logger is set to intercept all logs and display them in the console. $console = (new Apix\Log\Logger\Stream('php://stdout')) ->setMinLevel('debug') ->setFormat(new Apix\Log\Format\ConsoleColors()) - ->notice('Running out of {items}', ['items' => 'beers']); + ->notice('Running out of {items}', 'Running out of {items} - left {left}', [ + 'items' => 'beers', + 'left' => 5, + ]); ``` - [2023-03-20 08:01:25] NOTICE Running out of beers + [2023-03-20 08:01:25] NOTICE Running out of beers - left 5 ## Advanced usage ~ *multi-logs dispatcher* -Let's create an additional logger with purpose of catching log entries that have a severity level of `warning` or more. See the [log levels](#log-levels) for the order. +Let's create an additional logger with purpose of catching log entries that have a severity level of `warning` or more.\ +See the [log levels](#log-levels) for the order. ```php $file = (new Apix\Log\Logger\File(__DIR__ . '/app.log')) @@ -61,11 +65,11 @@ $file = (new Apix\Log\Logger\File(__DIR__ . '/app.log')) ->setDeferredTrigger(100); ``` -`setCascading()` set to *false* (default: *true*) so the entries caught here won't continue downstream past that particular log bucket.\ -`setDeferred()` was set to *true* (default: *false*) so processing happens when: -- `setDeferredTrigger` is reached -- `flushDeferredLogs` is called -- `__destruct` (end of script generally) +- `setCascading()` set to *false* (default: *true*) so the entries caught here won't continue downstream past that particular log bucket.\ +- `setDeferred()` was set to *true* (default: *false*) so processing happens when: + - `setDeferredTrigger` is reached + - `flushDeferredLogs` is called + - `__destruct` (end of script generally) Now, let's create a main logger object and inject the two previous loggers.