Skip to content

Commit a60167b

Browse files
Update README
1 parent d7e5a92 commit a60167b

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,28 @@
22

33
The memory usage enricher for Serilog.
44

5-
[![Build status](https://ci.appveyor.com/api/projects/status/ihq58voxyfwfanyg?svg=true)](https://ci.appveyor.com/project/serilog/serilog-enrichers-process) [![NuGet Version](http://img.shields.io/nuget/v/Serilog.Enrichers.Process.svg?style=flat)](https://www.nuget.org/packages/Serilog.Enricher.Process/)
5+
[![Build status](https://ci.appveyor.com/api/projects/status/22t518uadi80n9ge?svg=true)](https://ci.appveyor.com/project/JoshSchreuder/serilog-enrichers-memory) [![NuGet Version](https://img.shields.io/nuget/v/Serilog.Enrichers.Memory.svg)](https://www.nuget.org/packages/Serilog.Enrichers.Memory/)
66

77

8+
# Documentation
9+
810
To use the enricher, first install the NuGet package:
911

1012
```powershell
1113
Install-Package Serilog.Enrichers.Memory
1214
```
1315

14-
# Documentation
16+
Then enrich your logging configuration:
17+
18+
```csharp
19+
new LoggerConfiguration()
20+
.Enrich.WithMemoryUsage();
21+
```
22+
23+
And finally utilise the token in your logging template:
24+
25+
```csharp
26+
var template = "{MemoryUsage}";
27+
```
1528

1629
Copyright © 2017 Josh Schreuder - Provided under the [Apache License, Version 2.0](http://apache.org/licenses/LICENSE-2.0.html).

0 commit comments

Comments
 (0)