Merge pull request #10 from nblumhardt/dev

Updated to Serilog 2.5, README updates

Author: nblumhardt

README.md

@@ -1,7 +1,6 @@
-# Serilog.Sinks.Console
-[![Build status](https://ci.appveyor.com/api/projects/status/w1w3m1wyk3in1c96/branch/master?svg=true)](https://ci.appveyor.com/project/serilog/serilog-sinks-console/branch/master) [![NuGet Version](http://img.shields.io/nuget/v/Serilog.Sinks.Console.svg?style=flat)](https://www.nuget.org/packages/Serilog.Sinks.Console/) [![Documentation](https://img.shields.io/badge/docs-wiki-yellow.svg)](https://github.com/serilog/serilog/wiki) [![Join the chat at https://gitter.im/serilog/serilog](https://img.shields.io/gitter/room/serilog/serilog.svg)](https://gitter.im/serilog/serilog) [![Help](https://img.shields.io/badge/stackoverflow-serilog-orange.svg)](http://stackoverflow.com/questions/tagged/serilog)
+# Serilog.Sinks.Console [![Build status](https://ci.appveyor.com/api/projects/status/w1w3m1wyk3in1c96/branch/master?svg=true)](https://ci.appveyor.com/project/serilog/serilog-sinks-console/branch/master) [![NuGet Version](http://img.shields.io/nuget/v/Serilog.Sinks.Console.svg?style=flat)](https://www.nuget.org/packages/Serilog.Sinks.Console/) [![Documentation](https://img.shields.io/badge/docs-wiki-yellow.svg)](https://github.com/serilog/serilog/wiki) [![Join the chat at https://gitter.im/serilog/serilog](https://img.shields.io/gitter/room/serilog/serilog.svg)](https://gitter.im/serilog/serilog) [![Help](https://img.shields.io/badge/stackoverflow-serilog-orange.svg)](http://stackoverflow.com/questions/tagged/serilog)
 
-A simple Serilog sink that writes log events as text to `STDOUT`. For **colored console** output, check out [Serilog.Sinks.Literate](https://github.com/serilog/serilog-sinks-literate), which is designed for interactive use.
+A Serilog sink that writes log events to the Windows Console or an ANSI terminal via standard output. Coloring and custom themes are supported, including ANSI 256-color themes on macOS, Linux and Windows 10. The default output is plain text; JSON formatting can be plugged in using a package such as [_Serilog.Formatting.Compact_](https://github.com/serilog/serilog-formatting-compact).
 
 ### Getting started
 
@@ -24,31 +23,58 @@ Log.Information("Hello, world!");
 Log events will be printed to `STDOUT`:
 
 ```
-2016-07-08 12:50:51 [Information] Hello, world!
+[12:50:51 INF] Hello, world!
 ```
 
+### Themes
+
+The sink will colorize output by default:
+
+![Colorized Console](https://raw.githubusercontent.com/serilog/serilog-sinks-console/dev/assets/Screenshot.png)
+
+Themes can be specified when configuring the sink:
+
+```csharp
+    .WriteTo.Console(theme: AnsiConsoleTheme.Code)
+```
+
+The following built-in themes are available:
+
+ * `ConsoleTheme.None` - no styling
+ * `SystemConsoleTheme.Literate` - styled to replicate _Serilog.Sinks.Literate_, using the `System.Console` coloring modes supported on all Windows/.NET targets; **this is the default when no theme is specified**
+ * `SystemConsoleTheme.Grayscale` - a theme using only shades of gray, white, and black
+ * `AnsiConsoleTheme.Literate` - an ANSI 16-color version of the "literate" theme; we expect to update this to use 256-colors for a more refined look in future
+ * `AnsiConsoleTheme.Grayscale` - an ANSI 256-color version of the "grayscale" theme
+ * `AnsiConsoleTheme.Code` - an ANSI 256-color Visual Studio Code-inspired theme
+
+ Adding a new theme is straightforward; examples can be found in the [`SystemConsoleThemes`](https://github.com/serilog/serilog-sinks-console/blob/dev/src/Serilog.Sinks.Console/Sinks/SystemConsole/Themes/SystemConsoleThemes.cs) and [`AnsiConsoleThemes`](https://github.com/serilog/serilog-sinks-console/blob/dev/src/Serilog.Sinks.Console/Sinks/SystemConsole/Themes/AnsiConsoleThemes.cs) classes.
+
 ### Output templates
 
 The format of events to the console can be modified using the `outputTemplate` configuration parameter:
 
 ```csharp
     .WriteTo.Console(
-        outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss} [{Level}] {Message}{NewLine}{Exception}")
+        outputTemplate: "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}")
 ```
 
 The default template, shown in the example above, uses built-in properties like `Timestamp` and `Level`. Properties from events, including those attached using [enrichers](https://github.com/serilog/serilog/wiki/Enrichment), can also appear in the output template.
 
-For more compact level names, use a format such as `{Level:u3}` or `{Level:w3}` for three-character upper- or lowercase level names, respectively.
-
 ### JSON output
 
-To write JSON instead of plain text, pass an appropriate `ITextFormatter` to the `Console()` configuration method:
+The sink can write JSON  output instead of plain text. `CompactJsonFormatter` or `RenderedCompactJsonFormatter` from [Serilog.Formatting.Compact](https://github.com/serilog/serilog-formatting-compact) is recommended:
+
+```powershell
+Install-Package Serilog.Formatting.Compact
+```
+
+Pass a formatter to the `Console()` configuration method:
 
 ```csharp
-    .WriteTo.Console(new JsonFormatter())
+    .WriteTo.Console(new CompactJsonFormatter())
 ```
 
-[Serilog.Formatting.Compact](https://github.com/serilog/serilog-formatting-compact) provides alternatives to the default `JsonFormatter`.
+Output theming is not available when custom formatters are used.
 
 ### XML `<appSettings>` configuration
 
@@ -105,4 +131,16 @@ In your `appsettings.json` file, under the `Serilog` node, :
 }
 ```
 
-_Copyright &copy; 2016 Serilog Contributors - Provided under the [Apache License, Version 2.0](http://apache.org/licenses/LICENSE-2.0.html)._
+### Upgrading from _Serilog.Sinks.Console_ 2.x
+
+To achieve output identical to version 2 of this sink, specify a formatter and output template explicitly:
+
+```csharp
+    .WriteTo.Console(new MessageTemplateTextFormatter(
+        "{Timestamp:yyyy-MM-dd HH:mm:ss} [{Level}] {Message}{NewLine}{Exception}",
+        null))
+```
+
+This will bypass theming and use Serilog's built-in message template formatting.
+
+_Copyright &copy; 2017 Serilog Contributors - Provided under the [Apache License, Version 2.0](http://apache.org/licenses/LICENSE-2.0.html)._

assets/Screenshot.png

@@ -33,7 +33,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Serilog" Version="2.5.0-dev-00855" />
+    <PackageReference Include="Serilog" Version="2.5.0" />
   </ItemGroup>
 
   <ItemGroup Condition=" '$(TargetFramework)' == 'net45' ">