Create README.md

README.md

@@ -0,0 +1,26 @@
+# UnityEventVisualizer
+
+<h2>What</h2>
+Have you ever come across a project that abuses linking ```UnityEvents``` in the inspector and now you can not find who is calling what?
+<b>Unity Event Visualizer</b> is a visual tool that allows you to see all the UnityEvents in a scene at a glance.
+
+It creates a graph in which nodes are <b>gameobjects</b>, outputs are any type of UnityEvent (custom ones supported as well!) and inputs are methods.
+![Screenshot](https://i.gyazo.com/414775c117a536f14c2a4103202798c7.png)
+
+<h2>How</h2>
+
+- Grab the installer from the <b>Releases</b> section and import it into your project.
+
+- Select ```Windows/Events Graph Editor``` you can open the graph.
+![Selector](https://media.giphy.com/media/l1J9LcPkjgvxoUsBW/giphy.gif)
+
+- Click on any node to highlight that <b>gameobjects</b> in your hiearchy. Alternatively right-click on any element in the hierarchy and select ```UnityEventGraph/FindThis``` to highlight it in the graph.
+![Finder](https://media.giphy.com/media/3ohhwhMwWW0URb8mfS/giphy.gif)
+
+This is a work-in-progress. Pull requests welcome!
+
+<h2>Who</h2>
+
+- Original idea by [SoylentGraham](https://github.com/SoylentGraham)
+- Code by [Luca Mefisto](https://github.com/MephestoKhaan) (myself)
+- Inspired by [Keijiro Takahashi](https://github.com/keijiro)