Merge pull request #1 from Guribo/development

Update 0.0.3

README.md

@@ -2,24 +2,54 @@
 
 Scripts that make developing with UDON for VRChat safer and more fun :)
 
+# Requirements
+
+ - [UdonSharp](https://github.com/MerlinVR/UdonSharp#requirements) as described by [Merlin](https://github.com/MerlinVR)
+
 ## Features
 
+#### Scene Checking
 * automatically checks the scene for empty public variables (*null*) and logs to the console (every time assets get saved)
 * allows checking manually via menu entry to allow instant navigation to errors
 
-## Usage
+#### Editor Scripting
+* UdonBehaviour Extension methods for changing and reading UdonBehaviour variables in Edit mode have been added.
 
-Use via menu or silently by saving the scene (Ctrl+s):
+## Usage and Examples
+
+### Scene Checking
+Use via menu or silently by saving the scene (Ctrl+s):  
 ![Menu](README/menu.png)
 
-Skip or show errors:
+Skip or show errors:  
 ![Error Dialog](README/errorMessage.png)
 
-Locate empty variable by name and allow easy fixing of variable (optionally (¬‿¬) ):
+Locate empty variable by name and allow easy fixing of variable (optionally (¬‿¬) ):  
 ![Error Location](README/errorLocation.png)
 
-Warns about potential errors is the console and clicking on the message will alos highlight the affected gameobject in the hierarchy:
+Warns about potential errors is the console and clicking on the message will alos highlight the affected gameobject in the hierarchy:  
 ![Error Navigation in Console](README/errorNavigationInConsole.png)
 
-In case all errors get skipped a conclusion will be presented:
-![Conclusion on Skipping](README/conclusion.png)
+In case all errors get skipped a conclusion will be presented:  
+![Conclusion on Skipping](README/conclusion.png)
+
+### Editor Scripting
+> [Example script](Scripts/Examples/InspectorValueChangerExample.cs)
+````c#
+public UdonBehaviour editorTestingBehaviour;
+
+public void TrySetVariables()
+{
+    editorTestingBehaviour.SetInspectorVariable("testInt", 100);
+    editorTestingBehaviour.SetInspectorVariable("testString", "Hello World");
+    editorTestingBehaviour.SetInspectorVariable("testTransform", gameObject.transform);
+    editorTestingBehaviour.SetInspectorVariable("testGameObject", gameObject);
+    editorTestingBehaviour.SetInspectorVariable("testScriptReference", editorTestingBehaviour);
+}
+
+...
+````
+
+![Conclusion on Skipping](README/inspectorValueChangerExample.gif)  
+*Example scene and scripts are included*
+