Update README.md

- Simplified README content.
- Removed Example Gif and deleted file to reduce footprint.
- Made a wiki for more detailed info.

Author: FrayedFunction

README.md

@@ -1,19 +1,14 @@
-Unity Gizmo Drawer Tool
+Unity Gizmo Tool
 ==================
 
-![Visualizing waypoints for a moving platform and character look source.](ReadMeImgs/MovingPlatformExample-LineStrip.gif)
+# Description
+The Gizmo Tool enables you to use gizmos as components. This project is useful for level editing and other tasks where simple visualization is needed. See the [Wiki](https://github.com/MccDev260/com.mccdev260.gizmo-tool/wiki) section of the repo for more detail.
 
-Description
------------
-
-The Gizmo Drawer tool is a custom script that allows you to draw built in gizmos with customizable properties in the Unity scene. This script provides a versatile way to draw gizmos with a custom inspector to adjust their properties from within the editor.
-
-
-Features
---------
-* Has a custom Inspector to easily adjust gizmo properties directly in the Editor.
-* Supports nearly all gizmo types, **except Frustum**, as of Editor v2023.3
-* Customize the properties of each gizmo type, such as position, scale, color, and more.
+# Features
+* Draw Gizmos with a component for quick visualization in the editor.
+* Use a custom Inspector to easily adjust gizmo properties.
+* Supports most gizmo types.
+* All scripts in this package only run in the editor and are excluded from builds.
 
 ## Supported Types:
 *   Sphere
@@ -28,36 +23,37 @@ Features
 *   Icon
 *   GUI Texture
 
-Installation
-------------
+## Considerations
+Since this package is excluded from builds, be mindful of controlling `GizmoDrawer` with runtime scripts.
+See [Wiki/ExtendingBehaviour](https://github.com/MccDev260/com.mccdev260.gizmo-tool/wiki/Extending-Behviour) for a list of public members and suggested approaches.
 
+# Installation
 1.  Open Unity package manager window.
 2.  From the '+' menu in the top left corner, select '*Add package from git URL...*'
 3.  Copy and paste this repository's URL into the URL field.
 
-Usage
------
+# Getting Started
 1.  Attach the `GizmoDrawer` script to a GameObject in your scene.
-2.  In the Inspector, configure the gizmo properties based on your desired gizmo type.
-3.  Toggle the `drawOnSelectOnly` option to control whether the gizmo should be drawn only when the GameObject is selected.
-4.  Customize the gizmo's appearance by adjusting the color, size, scale, texture, and other relevant properties.
-5.  To see the gizmos in the Scene view, ensure the Gizmos toggle is enabled at the top of the Scene view.
+2.  Toggle the `drawOnSelectOnly` option to control whether the gizmo should be drawn only when the GameObject is selected.
+3.  Configure the gizmos properties with the custom inspector.
 
-Example
--------
-To draw a sphere gizmo:
+For more detailed explanation about each gizmo type and their properties, See the [Wiki](https://github.com/MccDev260/com.mccdev260.gizmo-tool/wiki) section of the repo.
+
+# Troubleshooting
+## I can't see gizmos in the scene view?
+- Make sure the Gizmos Menu is toggled on in the top right corner.
+    -  If this doesn't work - Expand menu, find `GizmoDrawer` in the scripts list and ensure it's enabled.
+- Check the `GizmoDrawer` properties in the inspector and ensure its origin is set to the expected value.
 
-1.  Attach the `GizmoDrawer` script to a GameObject.
-2.  Set the `gizmoType` to `Sphere`.
-3.  Either manually set the gizmos origin via the exposed Vector3 `originPos` property, or reference a target Transform with the `originTransfom` property.
-4.  Adjust the `floatRadius` to control the sphere's radius.
-5.  Optionally, customize the `gizmoColor` to change the sphere's color.
-6.  In the Scene view, the sphere gizmo will be drawn with the desired properties.
+References
+-------
+* [Unity - Scripting API: Gizmos](https://docs.unity3d.com/ScriptReference/Gizmos.html)
+* [Unity - Manual: Gizmos Menu](https://docs.unity3d.com/Manual/GizmosMenu.html).
 
 Contributing
 ------------
 
-Contributions are welcome! If you find any issues or want to enhance the project, feel free to fork this repository and submit pull requests.
+Contributions are welcome! If you have any problems or an idea for a new feature, feel free to submit a new issue [here](https://github.com/MccDev260/com.mccdev260.gizmo-tool/issues).
 
 License
 -------