From b40fab22953c5d492a054433a4618f472ea53fde Mon Sep 17 00:00:00 2001
From: NBKRedSpy <54865934+NBKRedSpy@users.noreply.github.com>
Date: Mon, 27 Mar 2023 20:37:37 -0400
Subject: [PATCH] README update

---
 README.md | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d9d41c0..9758bc7 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,28 @@
-# CardSurvival-Localization
\ No newline at end of file
+# CardSurvival-Localization
+
+A quick and dirty utility to extract localization data from ModLoader based mods.
+
+# Usage:
+Run the exe, passing in the folder, using wild cards.  
+
+|Arguments|Description|
+|--|--|
+|File Pattern|Use the full with *.json.  For example:  "SomeModLoaderMod\*.json"|
+|Output File|If not provided, will output to the console.  Otherwise will write to the path specified|
+
+# Output:
+Creates a CSV output text file with the following columns:
+Localization Key
+Empty
+The DefaultText for that key.
+
+Example:
+Bp_Hail_IceCoolBall.LogText,,冰晶球完成了
+
+An easy way to translate is using Google Sheets with the translate function.
+For example, translating Chinese to English: ```=GOOGLETRANSLATE(C1,"zh","en")```
+
+# Todo:
+* It should be changed to use tabs instead of commas since the text can have commas.
+* It needs to duplicates, or at least warn about them.  There are mods which have the same key multiple times.  Maybe just by need of the ModLoader format?
+