Merge tag 'versions/1.1' into develop

Added AnimatorStub, Animator extensions, and upgraded to 2017.3

Author: ashblue

Assets/Dist/AdncAnimatorHelpers.unitypackage

@@ -10,7 +10,7 @@ Grab the export package and import it into your Unity project
 
 ### AnimatorPlayback Objects
 
-How to use an AnimatorPlayback to play animations with variables.
+How to use the `AnimatorPlayback` object to play animations with variables.
 
 ![Preview of Playback Helper](/playback-helper-example.png)
 
@@ -52,6 +52,21 @@ public class AnimatorPlaybackExample : MonoBehaviour {
 Note that the AnimatorPlayback objects are fully unit and runtime tested
 due to their level of complexity.
 
+### Features
+   
+   * AnimatorPlayback objects to easily detect animation completion conditions
+   * Pre-built library on AnimatorBehavior(s) for complex animation playback
+   * Animator extensions that add missing functionality to Unity's Animator component
+   * Animator unit testing helper (for editor only tests)
+   * Unit tested
+
+#### Requesting Features
+
+Please file a GitHub [issue ticket](https://github.com/ashblue/unity-animator-helpers/issues) if you'd like to 
+request a feature.
+
+You can view the current [roadmap here](https://github.com/ashblue/unity-animator-helpers/projects/1).
+
 ## Animator Behaviors
 
 There are several animator helper scripts to assist you with Animator Behavior(s).
@@ -72,3 +87,81 @@ Here is a brief list of helpers. New ones will be added as the repo is updated o
 * SetVarRandomInt
 * RandomSpeed
 * RandomStartTime
+
+See documentation on methods (in code) for complete details.
+
+## Animator Extensions
+
+Unity Animator Helpers extends the pre-existing functionality of Unity3D's built in `Animator` component with static
+extensions. This doesn't hurt or break any existing functionality. For example you could do the following to check if 
+you have a particular bool parameter.
+
+```c#
+public class AnimatorExtensionExample : MonoBehaviour {
+    private Animator anim;
+    
+    public string hasAnimatorBool = "myBool";
+    
+    private void Start () {
+        anim = GetComponent<Animator>();
+        
+        Debug.LogFormat("Animator has bool {0}: {1}", hasAnimatorBool, anim.HasBool(hasAnimatorBool));
+    }
+}
+``` 
+
+### Available Animator extensions
+
+* HasParameter(name)
+* HasBool(name)
+* HasFloat(name)
+* HasInt(name)
+* HasTrigger(name)
+
+See documentation on methods (in code) for complete details.
+
+### Extension Caching 
+Animator extensions perform some caching to make lookups instant. This only happens on the first extension
+call per unique `AnimatorController`. While this generally shouldn't cause performance problems and is almost instant. 
+You may need to call `AnimatorHelperRuntime.Instance.Cache(Animator)` on `Start` or `Awake` if your `Animator(s)` 
+have over 300 parameters. Please note that your `AnimatorController` object (what you pass into the Animator via 
+inspector) must be uniquely named in order for the caching to work correctly.
+
+## Animator Unit Test Helper
+
+This library provides an `AnimatorStub` (editor only) class that makes testing animations via pure code super simple.
+All you need to do is the following.
+
+```c#
+using Adnc.AnimatorHelpers.Editors.Testing.Utilities;
+using NUnit.Framework;
+using UnityEngine;
+
+public class TestAnimatorStub {
+    private AnimatorStub _stub;
+    
+    [SetUp]
+    public void Setup () {
+        _stub = new AnimatorStub();
+    }
+
+    [TearDown]
+    public void Teardown () {
+        // The stub is attached to a GameObject, so it must be destroyed manually
+        Object.DestroyImmediate(_stub.Animator.gameObject);
+    }
+    
+    [Test]
+    public void MyTest () {
+        // Setup your AnimatorController as desired
+        stub.AnimatorCtrl.AddParameter("myBool", AnimatorControllerParameterType.Bool);
+        
+        // Inject a runtime version of the AnimatorController with all of your settings
+        stub.InjectCtrl();
+        
+        // Test as normal
+        // stub.Animator.Update(10); // If you need to simulate time
+        Assert.IsTrue(stub.Animator.HasBool("myBool));
+    }
+}
+```