Updated readme

Author: pandr

README.md

@@ -1,30 +1,49 @@
 # unity-debug-overlay
-A fast and garbage free debug overlay for Unity
+A fast and (almost) garbage free debug overlay for Unity. The projects contains two primary components: a debug overlay
+and a console.
+
+# Debug overlay
+The debug overlay, useful for displaying text and graphs that update every frame.
+Like this: ![Pretty picture](https://user-images.githubusercontent.com/4175246/28583020-e34a3a12-7167-11e7-8871-7199f410aa8d.gif)
+
+This can be done with some level of convenience using this code:
+
+```c#
+// FPS in top left corner
+ DebugOverlay.Write(1, 0, "FPS:{0,6:###.##}", 1.0f / Time.deltaTime);
+
+ // Small graph of FPS below
+ fpsHistory[Time.frameCount % fpsHistory.Length] = 1.0f / Time.deltaTime;
+ DebugOverlay.DrawGraph(1, 1, 9, 1.5f, fpsHistory, Time.frameCount % fpsHistory.Length, Color.green);
+```
+
+Even though it involves string formatting, not garbage will be generated.
+
+# Console
+The console is useful for checking logs / output while ingame and also for easily registrering commands
+that can be used to tweak the game behaviour or turn on/off debugging aspects.
 
 You can write stuff like
 
 ```c#
- DebugOverlay.Write(2, 2, "Hello, {0,-5} world!", Time.frameCount%100<50 ? "Happy" : "Evil");
- DebugOverlay.Write("FrameNo: {0,7}", Time.frameCount);
- DebugOverlay.Write("Time: {0,7:0000.00}", Time.time);
- DebugOverlay.Write("FPS: {0,7:###.##}", 1.0f / Time.deltaTime);
- DebugOverlay.Write("MonoHeap:{0,7} kb", (int)(UnityEngine.Profiling.Profiler.GetMonoUsedSizeLong() / 1024));
- DebugOverlay.DrawRect(20, 5.2f, 1.0f/Time.deltaTime*0.1f, 0.6f, Color.green);
- DebugOverlay.Write("PlayerPos: {0,6:000.0} {1,6:000.0} {2,6:000.0}",
- transform.position.x,
- transform.position.y,
- transform.position.z);
-
- /// Graphing
- System.Array.Copy(fpsArray, 1, fpsArray, 0, fpsArray.Length - 1);
- fpsArray[fpsArray.Length - 1] = 1.0f / Time.deltaTime;
- DebugOverlay.DrawHist(20, 10, 20, 3, fpsArray, Color.blue, 120.0f);
-
- System.Array.Copy(moveArray, 1, moveArray, 0, moveArray.Length - 1);
- moveArray[moveArray.Length - 1] = transform.parent.position.y;
- DebugOverlay.DrawHist(20, 15, 20, 3, moveArray, Color.red, 4.0f);
+
+// Register quit command
+ Game.console.AddCommand("quit", CmdQuit, "Quit game");
+
+ /* ... */
+
+ void CmdQuit(string[] args)
+ {
+ Game.console.
+ Application.Quit();
+ }
+
+
+
 ```
 
-and it will look like
+and it will look like this
+
+![Pretty picture](https://user-images.githubusercontent.com/4175246/28582984-d215e5f2-7167-11e7-99ff-e96b2981b9bb.gif)
+
 
-![Pretty picture](https://user-images.githubusercontent.com/4175246/27818480-0fcb0176-6096-11e7-9962-4371342402f2.png)