From d0eb095ebc67f3801b23d9056718d42b36d402d7 Mon Sep 17 00:00:00 2001 From: mc Date: Tue, 1 Jul 2025 14:08:06 +0000 Subject: [PATCH] Update README.md --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e1b867d..86697ae 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # portaloggy -A highly-portable, multi-platform, system-agnostic logging abstraction. Use portaloggy.ILogger everywhere. Make use of portaloggy.LoggerExtensions. Already contains ConsoleLogger for dead-simple console logging and AggregatedLogger for simultaneous logging to your own implementation of ILogger. \ No newline at end of file +A minimal, highly-portable, thread-safe .NET logging abstraction and implementation. Use `portaloggy.ILogger` everywhere. Make use of `portaloggy.LoggerExtensions` to make easy logging even easier. Already contains `ConsoleLogger` for dead-simple console logging and `AggregatedLogger` for simultaneous logging to multiple instances of `ILogger`. + + + +## Why + +Existing logging solutions were too complicated for me. I want something I just instantiate, it has no decorators, formatters, loaders, configs, extensions for init, and tons of other garbage just so it can log a fucking message to a console window. + +## How to use + +`var logger = new ConsoleLogger();` it's literally this simple. It will straight up start logging (pretty) messages to console, with accurate time, severity, message and even exception formatting and stacktrace if you provide the arguments. + +## How it works + +See `ILogger` interface. It's really simple. Use extensions to provide friendlier use for usual usecases separated by severity (`Warning()`, `Error()`, etc.). \ No newline at end of file