Merge branch 'master' of https://github.com/serilog/serilog-settings-configuration

Author: nblumhardt

README.md

@@ -1,2 +1,60 @@
-# serilog-framework-configuration
-A Serilog configuration provider that reads from Microsoft.Framework.Configuration
+# Serilog.Settings.Configuration
+
+A Serilog settings provider that reads from Microsoft.Extensions.Configuration, i.e. .NET Core's `appsettings.json` file.
+
+Configuration is read from the `Serilog` section.
+
+```json
+{
+  "Serilog": {
+    "Using":  ["Serilog.Sinks.Literate"],
+    "MinimumLevel": "Debug",
+    "WriteTo": [
+      { "Name": "LiterateConsole" },
+      { "Name": "File", "Args": { "path": "%TEMP%\\Logs\\serilog-configuration-sample.txt" } }
+    ],
+    "Enrich": {
+      "With": [
+        "FromLogContext",
+        "WithMachineName",
+        "WithThreadId"
+      ],
+      "WithProperties": {
+        "Application": "Sample"
+      }
+    }
+  }
+}
+```
+
+This example relies on the _Serilog.Sinks.Literate_, _Serilog.Sinks.File_, _Serilog.Enrichers.Environment_ and _Serilog.Sinks.Thread_ packages also being installed.
+
+After installing this package, use `ReadFrom.Configuration()` and pass an `IConfiguration` object.
+
+```csharp
+public class Program
+{
+    public static void Main(string[] args)
+    {
+        var configuration = new ConfigurationBuilder()
+            .AddJsonFile("appsettings.json")
+            .Build();
+
+        var logger = new LoggerConfiguration()
+            .ReadFrom.Configuration(configuration)
+            .CreateLogger();
+
+        logger.Information("Hello, world!");
+    }
+}
+```
+
+The `WriteTo` and `Enrich.With` sections support the same syntax, for example the following is valid if no arguments are needed by the sinks:
+
+```json
+"WriteTo": ["LiterateConsole", "DiagnosticTrace"]
+```
+
+Or alternatively, the long-form (`"Name":` ...) sytax from the first example can be used when arguments need to be supplied.
+
+(This package implements a convention using `ILibraryManager` to find any package with `Serilog` anywhere in the name and pulls configuration methods from it, so the `Using` example above is redundant.)