From 10e7ec8e4e9d364a25348facb72ef127ce6f9cc3 Mon Sep 17 00:00:00 2001
From: jie65535 <jie65535@qq.com>
Date: Wed, 3 Apr 2024 23:22:39 +0800
Subject: [PATCH] Update README

---
 Properties/AssemblyInfo.cs |  5 ++---
 README.md                  | 16 +++++++++++++++-
 2 files changed, 17 insertions(+), 4 deletions(-)

diff --git a/Properties/AssemblyInfo.cs b/Properties/AssemblyInfo.cs
index 32c3bb5..1cae534 100644
--- a/Properties/AssemblyInfo.cs
+++ b/Properties/AssemblyInfo.cs
@@ -1,16 +1,15 @@
 using System.Reflection;
-using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
 
 // 有关程序集的一般信息由以下
 // 控制。更改这些特性值可修改
 // 与程序集关联的信息。
 [assembly: AssemblyTitle("BalatroMessager")]
-[assembly: AssemblyDescription("")]
+[assembly: AssemblyDescription("A simple tool for listening to Steamodded logs")]
 [assembly: AssemblyConfiguration("")]
 [assembly: AssemblyCompany("")]
 [assembly: AssemblyProduct("BalatroMessager")]
-[assembly: AssemblyCopyright("Copyright ©  2024")]
+[assembly: AssemblyCopyright("Copyright © jie65535 2024")]
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
 
diff --git a/README.md b/README.md
index 5d9e2f1..8eefdfe 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,15 @@
-# BalatroMessager
\ No newline at end of file
+# BalatroMessager
+
+A simple tool for listening to [Steamodded](https://github.com/Steamopollys/Steamodded) logs.
+
+---
+
+This tool obtains all messages sent by the `sendDebugMessage` method by listening to and debugging output port `12345`.
+
+
+You can save the log by redirecting the output
+```bash
+BalatroMessager.exe > msg.log
+```
+
+or just double-click to run it.
\ No newline at end of file