diff --git a/ExtremelySimpleLogger/ExtremelySimpleLogger.csproj b/ExtremelySimpleLogger/ExtremelySimpleLogger.csproj index 8a4ad62..77cbb59 100644 --- a/ExtremelySimpleLogger/ExtremelySimpleLogger.csproj +++ b/ExtremelySimpleLogger/ExtremelySimpleLogger.csproj @@ -5,4 +5,13 @@ true + + Ellpeck + A very simple logger for .NET programs + logging logger utility debug trace output file + https://github.com/Ellpeck/ExtremelySimpleLogger + https://github.com/Ellpeck/ExtremelySimpleLogger + https://github.com/Ellpeck/ExtremelySimpleLogger/blob/master/LICENSE + 1.0.0 + diff --git a/README.md b/README.md new file mode 100644 index 0000000..be89a73 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# ExtremelySimpleLogger +**A very simple logger for .NET programs.** + +To set up an extremely simple logger, you have to create an instance of the `Logger` class: +```cs +var logger = new Logger { + Name = "My Logger", + Sinks = { + new FileSink("Log.txt", append: true), + new ConsoleSink() + } +}; +``` + +Since there are multiple ways for logging data to be processed, the logger needs to receive a set of `Sink` instances. By default, the following sinks are available: +- `FileSink`, which outputs logging data to a file +- `ConsoleSink`, which outputs logging data to the default console + +There are multiple ways to easily log messages with your newly created logger: +```cs +// Logging info +logger.Log(LogLevel.Info, "Some information"); +logger.Info("Some information, but shorter"); + +// Logging exceptions +try { + // some dangerous code +} catch (Exception e) { + logger.Error("An exception was thrown", e); +} +``` \ No newline at end of file diff --git a/Sample/Program.cs b/Sample/Program.cs index 6a63bc0..2524b47 100644 --- a/Sample/Program.cs +++ b/Sample/Program.cs @@ -7,7 +7,7 @@ namespace Sample { private static void Main() { var logger = new Logger { - Name = "Test Logger", + Name = "Example Logger", Sinks = { new FileSink("Log.txt", true) {MinimumLevel = LogLevel.Trace}, new ConsoleSink()