From e0629757fc83468581e52dec6eb7ee8e81930d4c Mon Sep 17 00:00:00 2001 From: Rolf Kristensen Date: Sun, 15 Oct 2023 09:21:51 +0200 Subject: [PATCH] Updated nuget-packages with README.md including install info and links --- src/NLog.Database/NLog.Database.csproj | 2 ++ src/NLog.Database/README.md | 23 +++++++++++++++++++ .../NLog.OutputDebugString.csproj | 2 ++ src/NLog.OutputDebugString/README.md | 21 +++++++++++++++++ .../NLog.WindowsEventLog.csproj | 2 ++ src/NLog.WindowsEventLog/README.md | 21 +++++++++++++++++ .../NLog.WindowsRegistry.csproj | 2 ++ src/NLog.WindowsRegistry/README.md | 21 +++++++++++++++++ 8 files changed, 94 insertions(+) create mode 100644 src/NLog.Database/README.md create mode 100644 src/NLog.OutputDebugString/README.md create mode 100644 src/NLog.WindowsEventLog/README.md create mode 100644 src/NLog.WindowsRegistry/README.md diff --git a/src/NLog.Database/NLog.Database.csproj b/src/NLog.Database/NLog.Database.csproj index 08e5fca1ce..220ffcf004 100644 --- a/src/NLog.Database/NLog.Database.csproj +++ b/src/NLog.Database/NLog.Database.csproj @@ -18,6 +18,7 @@ Docs: https://github.com/nlog/NLog/wiki/Database-target + README.md NLog;Database;SQL;logging;log N.png https://nlog-project.org/ @@ -92,6 +93,7 @@ + diff --git a/src/NLog.Database/README.md b/src/NLog.Database/README.md new file mode 100644 index 0000000000..0a52267a18 --- /dev/null +++ b/src/NLog.Database/README.md @@ -0,0 +1,23 @@ +# NLog Database Target + +NLog Database Target can write to any database that has ADO.NET Database Provider. Ex. NS-SQL, MySQL, SqLite, Oracle, etc. + +Make sure to also install the nuget-package for the wanted Database Provider, and configure the [DbProvider](https://github.com/NLog/NLog/wiki/Database-target#dbprovider-examples) for the Database Target. + +See the [NLog Wiki](https://github.com/NLog/NLog/wiki/Database-target) for available options and examples. + +## Register Extension + +NLog will only recognize type-alias `database` when loading from `NLog.config`-file, if having added extension to `NLog.config`-file: + +```xml + + + +``` + +Alternative register from code using [fluent configuration API](https://github.com/NLog/NLog/wiki/Fluent-Configuration-API): + +```csharp +LogManager.Setup().SetupExtensions(ext => ext.RegisterTarget()); +``` diff --git a/src/NLog.OutputDebugString/NLog.OutputDebugString.csproj b/src/NLog.OutputDebugString/NLog.OutputDebugString.csproj index f566a56b37..ff6b07341c 100644 --- a/src/NLog.OutputDebugString/NLog.OutputDebugString.csproj +++ b/src/NLog.OutputDebugString/NLog.OutputDebugString.csproj @@ -16,6 +16,7 @@ OutputDebugStringTarget Docs: https://github.com/NLog/NLog/wiki/OutputDebugString-target + README.md NLog;Windows;DebugView;logging;log N.png https://nlog-project.org/ @@ -60,6 +61,7 @@ + diff --git a/src/NLog.OutputDebugString/README.md b/src/NLog.OutputDebugString/README.md new file mode 100644 index 0000000000..aed1dcd321 --- /dev/null +++ b/src/NLog.OutputDebugString/README.md @@ -0,0 +1,21 @@ +# NLog OutputDebugString Target + +NLog OutputDebugString Target writes to the [OutputDebugString](https://msdn.microsoft.com/da-dk/library/windows/desktop/aa363362.aspx) Win32 API, which can be monitored using debugger tools like DebugView. + +See the [NLog Wiki](https://github.com/NLog/NLog/wiki/OutputDebugString-target) for available options and examples. + +## Register Extension + +NLog will only recognize type-alias `OutputDebugString` when loading from `NLog.config`-file, if having added extension to `NLog.config`-file: + +```xml + + + +``` + +Alternative register from code using [fluent configuration API](https://github.com/NLog/NLog/wiki/Fluent-Configuration-API): + +```csharp +LogManager.Setup().SetupExtensions(ext => ext.RegisterTarget()); +``` diff --git a/src/NLog.WindowsEventLog/NLog.WindowsEventLog.csproj b/src/NLog.WindowsEventLog/NLog.WindowsEventLog.csproj index b8b1bcbb08..7c4b4837af 100644 --- a/src/NLog.WindowsEventLog/NLog.WindowsEventLog.csproj +++ b/src/NLog.WindowsEventLog/NLog.WindowsEventLog.csproj @@ -18,6 +18,7 @@ Docs: https://github.com/nlog/NLog/wiki/EventLog-target + README.md NLog;EventLog;logging;log N.png https://nlog-project.org/ @@ -61,6 +62,7 @@ + diff --git a/src/NLog.WindowsEventLog/README.md b/src/NLog.WindowsEventLog/README.md new file mode 100644 index 0000000000..7efd0ab43b --- /dev/null +++ b/src/NLog.WindowsEventLog/README.md @@ -0,0 +1,21 @@ +# NLog EventLog Target + +NLog EventLog Target writes to the Windows EventLog. + +See the [NLog Wiki](https://github.com/nlog/nlog/wiki/EventLog-target) for available options and examples. + +## Register Extension + +NLog will only recognize type-alias `eventlog` when loading from `NLog.config`-file, if having added extension to `NLog.config`-file: + +```xml + + + +``` + +Alternative register from code using [fluent configuration API](https://github.com/NLog/NLog/wiki/Fluent-Configuration-API): + +```csharp +LogManager.Setup().SetupExtensions(ext => ext.RegisterTarget()); +``` diff --git a/src/NLog.WindowsRegistry/NLog.WindowsRegistry.csproj b/src/NLog.WindowsRegistry/NLog.WindowsRegistry.csproj index 38eca50deb..c44cad20f8 100644 --- a/src/NLog.WindowsRegistry/NLog.WindowsRegistry.csproj +++ b/src/NLog.WindowsRegistry/NLog.WindowsRegistry.csproj @@ -16,6 +16,7 @@ RegistryLayoutRenderer Docs: https://github.com/NLog/NLog/wiki/Registry-Layout-Renderer + README.md NLog;Windows;Registry;logging;log N.png https://nlog-project.org/ @@ -70,6 +71,7 @@ + diff --git a/src/NLog.WindowsRegistry/README.md b/src/NLog.WindowsRegistry/README.md new file mode 100644 index 0000000000..20ad0e4e8d --- /dev/null +++ b/src/NLog.WindowsRegistry/README.md @@ -0,0 +1,21 @@ +# NLog Registry LayoutRenderer + +NLog Registry LayoutRenderer to output value from Windows Registry. + +See the [NLog Wiki](https://github.com/NLog/NLog/wiki/Registry-Layout-Renderer) for available options and examples. + +## Register Extension + +NLog will only recognize type-alias `registry` when loading from `NLog.config`-file, if having added extension to `NLog.config`-file: + +```xml + + + +``` + +Alternative register from code using [fluent configuration API](https://github.com/NLog/NLog/wiki/Fluent-Configuration-API): + +```csharp +LogManager.Setup().SetupExtensions(ext => ext.RegisterLayoutRenderer()); +```