Merge branch 'master' of https://github.com/pandr/unity-debug-overlay.git

Author: pandr

README.md

@@ -2,32 +2,38 @@
 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)
+## Performance
+Garbage production is minimized by not really using strings a lot and by having convenience functions that mimick string
+formatting (using format strings like `"This: {0}"`) known from C#. Rendering happens through the magic of a few procedural draw calls
+and is quite fast.
+
+## Debug overlay
+The debug overlay is 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
+ // 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.
+Even though it looks like regular string formatting, no garbage will be generated.
 
-# Console
+## 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
+You can write
 
 ```c#
-
-// Register quit command
+ // Register quit command
  Game.console.AddCommand("quit", CmdQuit, "Quit game");
 
  /* ... */
@@ -37,12 +43,9 @@ You can write stuff like
  Game.console.
  Application.Quit();
  }
-
-
-
 ```
 
-and it will look like this
+and it will work like this:
 
 ![Pretty picture](https://user-images.githubusercontent.com/4175246/28582984-d215e5f2-7167-11e7-99ff-e96b2981b9bb.gif)