From 035a95be45c51eadc5f2ffe5c29b3d6eb150c1d2 Mon Sep 17 00:00:00 2001
From: CJ-SPT <161484149+CJ-SPT@users.noreply.github.com>
Date: Fri, 14 Jun 2024 19:17:29 -0400
Subject: [PATCH] Update README.md

---
 README.md | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 31d6776..b1baaab 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,16 @@
-# AssemblyRemapper
\ No newline at end of file
+# ReCodeIt
+
+ReCodeIt is a .net assembly remapper, it can take an assembly which has been de-obfuscated and remap classes to more usable names based on patterns. It ***requires*** a de-obfuscated dll to work.
+
+# Building
+- fork or clone the project to a local directory
+- Make sure you have  [.net 8 sdk](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) installed or install it through the visual studio installer.
+- Open the solution in visual studio and build
+- Run the project from visual studio or the build folder.
+
+# Using
+- Start the application, go to the settings page and set the directories and options to your liking. I will provide further documentation down the line when the project is in a less chaotic state. For now using it works, there may be a GUI bug here or there.
+
+# Planned Features
+- Cross Mapping - The ability to code in a de-obfuscated state and then convert your code back to a state the original assembly understands once your done. This provide the ability to rename things to whatever you want and use them.
+- De-Obfuscation - Taking a obfuscated dll and de-obfuscating it