From 79b714a3c044bead0c6106e44ae2a64192de3df2 Mon Sep 17 00:00:00 2001
From: David <19684420+GroxicTinch@users.noreply.github.com>
Date: Mon, 12 May 2025 17:30:07 +0800
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c47a869
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+Features
+* Make a copy of a node without inputs or outputs, the widgets on the mirror node is two way synced to the original.
+* Hide widgets you don't care about, or re-enable if you want it back.
+* Rearrange widgets to put your favorite up the top.
+* Jump from the mirror node to the original node.
+
+Why not just use Get and Set nodes instead?
+
+Get and Set nodes are amazing, but:
+* They create breaks in otherwise easy to follow paths
+* You need to hide the Get node behind your input nodes if you are trying to minimize dead space
+* It splits logic into groups, the "nice looking" part, and the important back end.
+
+Why hasn't it been released?
+
+I still need to fix a few things, there are some pretty big bugs that I need to work on, mainly
+* If the original node is deleted, the mirror node will still function but not update a real node and then on a reload could link to an incorrect node causing issues.
+* Reordering the widgets work when the workflow is saved, but if you just refresh the window then for some reason the order doesn't save properly
+* Multi-line text cant be hidden
+* Other custom widgets aren't supported and I don't know how I would go about fixing that without hard-coding them.
+* Adding multiple mirrors work, but break the method I use to restore the original node's callback function.
+
+Future Plans
+
+If I have enough time and can find ways to do it, I would love to add the following features
+* Hide title bar of mirror node.
+* Fix the 10px under the last widget that I can't seem to remove.
+* Allow combining of multiple real nodes into one mirror node.