Merge branch 'master' of https://github.com/cleavetv/unity-framework

Author: cleavetv

Docs/About.md

@@ -1,5 +1,9 @@
 # About
 
 CleaveFramework is maintained by [CleaveTV](https://github.com/cleavetv).
+
 You can contact the author directly via email: [email protected]
+
 Development began on June 6th, 2014.
+
+Community reddit page available: [CleaveTV Sub-Reddit](http://www.reddit.com/r/CleaveFramework/)

Docs/BinderObject.md

@@ -9,14 +9,22 @@ Binder is a generic binding wrapper for C#'s Dictionary.
 var intToString = new Binder<int, string>();
 // make a binder that binds strings to ints:
 var stringToInt = new Binder<string, int>();
+```
 
 ## Add some bindings:
 
-``csharp
+```csharp
+// function style
 intToString.Bind(11, "eleven");
 intToString.Bind(31, "thirty-one");
 stringToInt.Bind("eleven", 11);
 stringToInt.Bind("thirty-one", 31);
+
+// or with [] operator
+intToString[11] = "eleven";
+intToString[31] = "thirty-one";
+stringToInt["eleven"] = 11;
+stringToint["thirty-one"] = 31;
 ```
 
 ## Check a binding:
@@ -38,3 +46,37 @@ if(stringToInt.IsBound("eleven")) {
 }
 ```
 
+## Remove a binding:
+
+```csharp
+intToString.Clear(11);
+```
+
+## Remove all bindings
+
+```csharp
+intToString.Clear();
+```
+
+## Reverse resolve, find a list of keys matching a given value
+
+```csharp
+var Books = new Binding<string, string>();
+var author = "Dr Suess";
+Books["Cat In the Hat"] = author;
+Books["Green Eggs and Ham"] = author;
+Books["The Lorax"] = author;
+Books["Hop On Pop"] = author;
+author = "Shel Silverstein";
+Books["The Giving Tree"] = author;
+Books["Where The Sidewalk Ends"] = author;
+IEnumerable<string> booksByDrSuess = Books.FindKeyMatches("Dr Suess"); // returns 4 strings matching Dr Suess
+IEnumerable<string> booksByShel = Books.FindKeyMatches("Shel Silverstein"); // returns 2 strings matching Shel Silverstein
+```
+
+## Size of bindings
+
+```csharp
+int binds = Books.Count; // 6
+```
+

Docs/CorePrincipals.md

@@ -7,8 +7,7 @@
  - SceneView has an abstract method named `Initialize()` which you must implement in your derived `GameSceneView` object.  It is within this method that you can begin to set up and start your scene.
  - The Framework has two "namespaces" reserved for storing and manipulating objects in memory.
    * Global space 
-     - `Framework` contains a static accessor available at `Framework.Globals` which is the Global space object container.   
+     - `Framework` contains a static accessor available at `Framework.Globals` which is the Global space object container.       - A Global object will remain alive for the entire duration of your applications lifetime from the moment you create it until the moment the game closes. 
    * Scene space.  
      - `SceneView`'s base class contains a property called `SceneObjects` which is the Scene space object container.
- - A Global object will remain alive for the entire duration of your applications lifetime from the moment you create it until the moment the game closes.
- - A Scene object will remain alive only up until the point where you tell the framework to change scenes. 
+     - A Scene object will remain alive only up until the point where you tell the framework to change scenes. 

Docs/InjectorObject.md

@@ -4,6 +4,9 @@ Dependency Injector is able to automatically provide objects with resolved depen
 
 The Injector currently only supports Property and Field injection.
 
+## Caching
+Injector will cache your objects injectable members the first time it is asked to inject into an object of a given type.  Subsequent injections into that type will use the cached values rather then additional reflection which should provide much improved performance.
+
 ## [Inject] Attribute
 [Inject] is a C# attribute which precedes the object you want the Injector to inject for you.
 We can inject into a C# object like:
@@ -73,4 +76,4 @@ object ConstructObjectA(object obj)
 ```
 
 ## Pattern notes:
-Binding to interfaces is a very powerful technique which can and should be taken advantage of where ever possible.  This gives your code the flexibility to change between concrete implementation types at your discretion without modifying the requesting objects or their usage of the implementation.
+Binding to interfaces is a very powerful technique which can and should be taken advantage of where ever possible.  This gives your code the flexibility to change between concrete implementation types at your discretion without modifying the requesting objects or their usage of the implementation.

Docs/SceneObjectDataObject.md

@@ -34,7 +34,7 @@ A SceneObjects Singleton type is a 1-to-1 mapping of a System.Type to an instanc
 #### Adding a singleton
 ```csharp
 // add one specific instance of a Foo
-SceneObjects.PushObjectAsSingleton<Foo>(new Foo());
+SceneObjects.PushSingleton<Foo>(new Foo());
 ```
 
 #### Resolving the singleton
@@ -54,7 +54,7 @@ A SceneObjects Transient type is a mapping of a System.Type to a Name/Type insta
 ```csharp
 // add a few instances of Foo named Foo0 through Foo4
 for(var i = 0; i < 5; i++) {
-	SceneObjects.PushObjectAsTransient<Foo>("foo" + i, new Foo());
+	SceneObjects.PushTransient<Foo>("foo" + i, new Foo());
 }
 ```
 

Docs/SceneViewObject.md

@@ -12,6 +12,6 @@ When `SceneView.OnDestroy` is called by the UnityEngine or by your overriden imp
 
 ## SceneView.Initialize()
 
-`SceneView.Initialize()` is an abstract method required by your implementations of each `SceneView`.  It is automatically invoked by the [SceneManager](SceneManagerObject.md) upon receiving the `SceneLoadedCmd` Command Type.  
+`SceneView.Initialize()` is an abstract method required by your implementations of each `SceneView`.  It is automatically invoked by the [SceneManager](SceneManagerObject.md) upon receiving the `SceneLoadedCmd` Command Type.  When execution of this method returns the SceneManager will automatically call `InitializeSceneObjects()` on the current `SceneView`'s instance of `SceneObjectData`
 
 ###### `SceneLoadedCmd` is the framework event which occurs after UnityEngine is done building the hierarchy for your scene as serialized by the UnityEditor.  

Readme.md

@@ -1,4 +1,4 @@
-# CleaveFramework v0.2.0
+# CleaveFramework v0.2.1
 
 A Unity3D C# application framework.
 
@@ -24,14 +24,6 @@ A Unity3D C# application framework.
 
 Most of these features are optional modules you can use as much or as little of as your project requires.
 
-## Why you use a framework
-
-A good application framework allows it's users to save time by using generic code that allows them to focus on more project-specific areas.  
-
-A great application framework provides it's users with excellent, fast, well tested, and well maintained generic modules capable of providing their application with a structure they can depend on.
-
-Every piece of software you've even worked with has utilized a framework in one way or another.  Whether it was home-rolled or an off the shelf solution the very structure of your code base makes up the framework it executes on.  If you've ever finished, or worse started and not finished, a project using the Unity3D engine you realize the importance of well structuring your code.  If find yourself re-implementing the same functionality from project to project time and time again then you are a great candidate for migrating your work-flow into a framework package.
-
 ## Documentation
 
 ### [About](https://github.com/cleavetv/unity-framework/blob/master/Docs/About.md)
@@ -44,4 +36,8 @@ Every piece of software you've even worked with has utilized a framework in one
 ### [Quick Snippets](https://github.com/cleavetv/unity-framework/blob/master/Docs/QuickSnippets.md)
 ### [Contributions](https://github.com/cleavetv/unity-framework/blob/master/Docs/Contributions.md)
 
+## Community
+
+If you've got questions, want to request a feature, report a bug, or show off a project using the framework come talk about it on [reddit](http://www.reddit.com/r/CleaveFramework/)
+