Skip to content

Commit 45b9379

Browse files
Update README
1 parent 86d3eee commit 45b9379

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
1-
# Serilog.Sinks.Notepad [![NuGet Version](http://img.shields.io/nuget/v/Serilog.Sinks.Notepad.svg?style=flat)](https://www.nuget.org/packages/Serilog.Sinks.Notepad) [![Stack Overflow](https://img.shields.io/badge/stack%20overflow-serilog-orange.svg)](http://stackoverflow.com/questions/tagged/serilog)
1+
| README.md |
2+
|:---|
3+
4+
<div align="center">
5+
6+
<img src="assets/serilog-sink-nuget.png" alt="Serilog.Sinks.Notepad" width="100" />
7+
8+
</div>
9+
10+
<h1 align="center">Serilog.Sinks.Notepad</h1>
11+
<div align="center">
212

313
A [Serilog](https://serilog.net) sink that writes log events to Notepad (_Yes, you've read it right!_). Simply open Notepad and immediately start receiving logs from your application, without even touching the filesystem.
414

15+
[![NuGet Version](http://img.shields.io/nuget/v/Serilog.Sinks.Notepad.svg?style=flat)](https://www.nuget.org/packages/Serilog.Sinks.Notepad) [![Stack Overflow](https://img.shields.io/badge/stack%20overflow-serilog-orange.svg)](http://stackoverflow.com/questions/tagged/serilog)
16+
517
![Screenshot of Serilog.Sinks.Notepad in action](assets/serilog-sinks-notepad-screenshot.png)
618

19+
</div>
20+
721
`Serilog.Sinks.Notepad` writes messages to the most recent `notepad.exe` started on current user's session, by default. This behavior can be changed in the sink configuration.
822

923
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).
@@ -12,7 +26,7 @@ The default output is plain text; JSON formatting can be plugged in using a pack
1226

1327
If you like or are using this project please give it a star. Thanks!
1428

15-
## Getting started
29+
## Getting started :rocket:
1630

1731
Install the [Serilog.Sinks.Notepad](https://www.nuget.org/packages/Serilog.Sinks.Notepad) package from NuGet:
1832

0 commit comments

Comments
 (0)