From 132f57e26885e1fae315e7ab08e5199de1817e31 Mon Sep 17 00:00:00 2001
From: katboi01 <katboi01@noreply.localhost>
Date: Wed, 11 Oct 2023 23:00:07 +0800
Subject: [PATCH] Add README.md

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3aaa080
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+This is a translation updater created for Vorked's KF3 Tranlsation project [KF3TL](https://github.com/Vorked/KF3TL)
+
+It provides a simple UI for updating the translation files for when new updates are published.
+
+<h2>Usage</h2>
+
+Most recent build is packaged with KF3TL's main download.
+
+Upon starting the game, if a new update is available, a button will appear at the top of the screen that can be clicked.
+
+Clicking the button will begin to download and extract the translation files (existing files will be overwritten!)
+
+If there are no new updates, or when the update finishes, the plugin disables itself and does not affect the game.
+
+<h2>Build</h2>
+
+Additional .dll's are required to build this addon from source. They can be found in `BepInEx\core\` and in `KFP2G\けもフレ３_Data\Managed\` directories.
\ No newline at end of file