Merge pull request #10 from tsimbalar/readme [Skip CI]

Properly document the enrichers included in the package

Author: tsimbalar

README.md

@@ -4,8 +4,35 @@ ASP.NET WebAPI support for [SerilogWeb.Classic](https://github.com/serilog-web/c
 
 *Package* - <a href="https://www.nuget.org/packages/serilogweb.classic.webapi">SerilogWeb.Classic.WebApi</a> | Platforms - .NET 4.5
 
-This package is used in conjunction with _SerilogWeb.Classic_ to support 
-logging WebAPI exceptions with [Serilog](http://serilog.net).
+_This package is designed for full framework ASP.NET applications. For ASP.NET Core, have a look at [Serilog.AspNetCore](https://github.com/serilog/serilog-aspnetcore)_
 
+This package is used in conjunction with _SerilogWeb.Classic_ and adds : 
+- support for logging WebAPI exceptions with [Serilog](http://serilog.net)
+- Web API specific enrichers
 
+## Enrichers
+The following enrichers are available in the `SerilogWeb.Classic.WebApi.Enrichers` namespace:
+- **WebApiActionNameEnricher** : adds a property `WebApiAction` containing the name of the *Action* being executed in the *Web API Controller*
+- **WebApiControllerNameEnricher** : adds a property `WebApiController` containing the name of the *Controller* in which a *Web API Action* has executed
+- **WebApiRouteDataEnricher** : adds a property `WebApiRouteData` containing the dictionary of the *RouteData*
+- **WebApiRouteTemplateEnricher** : adds a property `WebApiRouteTemplate` containing the *route template* selected by Web API routing
 
+
+Usage : 
+
+```csharp
+var log = new LoggerConfiguration()
+    .WriteTo.Console()
+    .Enrich.With<WebApiRouteTemplateEnricher>()
+    .Enrich.With<WebApiActionNameEnricher>()
+    .CreateLogger();
+```
+
+To override the property name of the added property:
+
+```csharp
+var log = new LoggerConfiguration()
+    .WriteTo.Console()
+    .Enrich.With(new WebApiRouteTemplateEnricher("RouteTemplate")
+    .CreateLogger();
+```