From ee39c876592179d40712b65770cafc5c9b3cb460 Mon Sep 17 00:00:00 2001
From: glax <johanna@bernloehr.eu>
Date: Thu, 1 Feb 2024 21:50:40 +0100
Subject: [PATCH] Add README.md

---
 GlaxLogger/GlaxLogger.csproj |  4 ++++
 README.md                    | 10 ++++++++++
 2 files changed, 14 insertions(+)
 create mode 100644 README.md

diff --git a/GlaxLogger/GlaxLogger.csproj b/GlaxLogger/GlaxLogger.csproj
index 4e5bb4e..316315a 100644
--- a/GlaxLogger/GlaxLogger.csproj
+++ b/GlaxLogger/GlaxLogger.csproj
@@ -12,6 +12,10 @@
     <ItemGroup>
       <PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0" />
     </ItemGroup>
+    
+    <PropertyGroup>
+        <None Include="..\README.md" Pack="true" PackagePath="\"/>
+    </PropertyGroup>
 
     <PropertyGroup>
         <PackageLicenseFile>LICENSE.md</PackageLicenseFile>
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f3fe5a3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# GlaxLogger
+
+## Usage
+```csharp
+Logger logger = new (filteredLevel: LogLevel.Trace, outputFolderPath: "logs");
+logger.Log(LogLevel.Information, "Content");
+```
+**Defaults**
+* `filteredLevel = LogLevel.Warning`
+* `outputFolderPath = Environment.CurrentDirectory`
\ No newline at end of file