Add more documentation to the README (duplicates the wiki content for now) [Skip CI]

Author: nblumhardt

README.md

@@ -1,3 +1,107 @@
-# Serilog.Settings.AppSettings [![Build status](https://ci.appveyor.com/api/projects/status/lpkpthfap819flva?svg=true)](https://ci.appveyor.com/project/serilog/serilog-settings-appsettings)
+# Serilog.Settings.AppSettings [![Build status](https://ci.appveyor.com/api/projects/status/lpkpthfap819flva?svg=true)](https://ci.appveyor.com/project/serilog/serilog-settings-appsettings) [![NuGet Version](http://img.shields.io/nuget/v/Serilog.Settings.AppSettings.svg?style=flat)](https://www.nuget.org/packages/Serilog.Settings.AppSettings/) [![Join the chat at https://gitter.im/serilog/serilog](https://img.shields.io/gitter/room/serilog/serilog.svg)](https://gitter.im/serilog/serilog)
 
-The XML `<appSettings>` reader for [Serilog](https://serilog.net). See the [documentation](https://github.com/serilog/serilog/wiki/AppSettings) for more information.
+An XML `<appSettings>` reader for [Serilog](https://serilog.net).
+
+### Getting started
+
+The `<appSettings>` support package needs to be installed from NuGet:
+
+```powershell
+Install-Package Serilog.Settings.AppSettings
+```
+
+To read configuration from `<appSettings>` use the `ReadFrom.AppSettings()` extension method on your `LoggerConfiguration`:
+
+```csharp
+Log.Logger = new LoggerConfiguration()
+  .ReadFrom.AppSettings()
+  ... // Other configuration here, then
+  .CreateLogger()
+```
+
+You can mix and match XML and code-based configuration, but each sink must be configured **either** using XML **or** in code - sinks added in code can't be modified via app settings.
+
+### Configuration syntax
+
+To configure the logger, an `<appSettings>` element should be included in the program's _App.config_ or _Web.config_ file.
+
+```xml
+<?xml version="1.0" encoding="utf-8" ?>
+<configuration>
+  <appSettings>
+    <add key="serilog:minimum-level" value="Verbose" />
+    <!-- More settings here -->
+```
+
+Serilog settings are prefixed with `serilog:`.
+
+### Setting the minimum level
+
+To set the logging level for the app use the `serilog:minimum-level` setting key. 
+
+```xml
+    <add key="serilog:minimum-level" value="Verbose" />
+```
+
+Valid values are those defined in the `LogEventLevel` enumeration: `Verbose`, `Debug`, `Information`, `Warning`, `Error`, `Fatal`.
+
+### Adding a sink
+
+Sinks are added with the `serilog:write-to` key. The setting name matches the configuration method name that you'd use in code, so the following are equivalent:
+
+```csharp
+    .WriteTo.LiterateConsole()
+```
+
+In XML:
+
+```xml
+    <add key="serilog:write-to:LiterateConsole" />
+```
+
+**NOTE: When using `serilog:*` keys need to be unique.**
+
+Sink assemblies must be specified using the `serilog:using` syntax. For example, to configure 
+
+```csharp
+<add key="serilog:using:LiterateConsole" value="Serilog.Sinks.Literate" />
+<add key="serilog:write-to:LiterateConsole"/>
+```
+
+If the sink accepts parameters, these are specified by appending the parameter name to the setting.
+
+```csharp
+    .WriteTo.RollingFile(@"C:\Logs\myapp-{Date}.txt", retainedFileCountLimit: 10)
+```
+
+In XML:
+
+```xml
+    <add key="serilog:write-to:RollingFile.pathFormat" value="C:\Logs\myapp-{Date}.txt" />
+    <add key="serilog:write-to:RollingFile.retainedFileCountLimit" value="10" />
+```
+
+Any environment variables specified in a setting value (e.g. `%TEMP%`) will be expanded appropriately when read.
+
+### Using sink extensions from additional assemblies
+
+To use sinks and enrichers from additional assemblies, specify them with a `serilog:using` key.
+
+For example, to use configuration from the `Serilog.Sinks.EventLog` assembly:
+
+```xml 
+    <add key="serilog:using:EventLog" value="Serilog.Sinks.EventLog" />
+    <add key="serilog:write-to:EventLog.source" value="Serilog Demo" />
+```
+
+### Enriching with properties
+
+To attach additional properties to log events, specify them with the `serilog:enrich:with-property` directive.
+
+For example, to add the property `Release` with the value `"1.2-develop"` to all events:
+
+```xml 
+    <add key="serilog:enrich:with-property:Release" value="1.2-develop" />
+```
+
+See the [Serilog documentation](https://github.com/serilog/serilog/wiki/AppSettings) for further information.