Merge pull request #188 from tshelburne/2.0-docs

Added new documentation for 2.0

CHANGELOG.md

@@ -1,3 +1,19 @@
+### 2.0.0 (2015-03-17)
+
+  * Expanded public interface of the `Loader` class to support:
+    - Trivial parsing of new document types
+    - Custom instantiation methods
+    - Custom setting of properties
+    - Custom processing and fixture building
+  * Added support for using parameters with the following
+    ```
+    parameters:
+        foo: value
+
+    Acme\ClassName:
+        property: <{foo}>
+    ```
+
 ### 1.7.2 (2014-10-10)
 
   * Fixed support for custom providers, using addProvider instead of setProviders lets you add single providers

README.md

@@ -94,6 +94,14 @@ $persister->persist($objects);
 
 This loader maintains its list of built objects, so `load` can be called multiple times with different files if your fixture file starts growing unmanageably large.
 
+Using the `Loader` class directly also allows you to add more customization to how your objects are instantiated, properties are set, and what kinds of files you can parse. The following methods are all available for these purposes:
+
+* `addParser`: Parsers handle new types of files
+* `addProcessor`: Processors handle new ways to generate properties
+* `addBuilder`: Builders handle the generation of fixtures themselves
+* `addInstantiator`: Instantiators handle creating instances
+* `addPopulator`: Populators handle setting properties on instances
+
 > **Note**: To load plain PHP files, the files must return an array containing the same structure as the yaml files have.
 
 ## Reference ##

UPGRADE.md

@@ -1,6 +1,26 @@
 # Breaking changes between Alice 1.x and 2.0
 
+Support for PHP 5.3 has been removed (most notably, we're using short array syntax), and we are no longer testing in CI against 5.3.
+
 In php fixtures, and nested faker blocks in yml fixtures, using `$this->fake()`
 or `$loader->fake()` is no longer supported.
 
 A closure is provided so you can now use the shorter `$fake()` instead.
+
+# New public interface
+
+## Fixtures
+
+The `Fixtures` interface has not been altered.
+
+## Loader
+
+The public interface of the `Loader` class has been expanded to include the following methods:
+
+* `addParser`: Parsers handle new types of files
+* `addProcessor`: Processors handle new ways to generate properties
+* `addBuilder`: Builders handle the generation of fixtures themselves
+* `addInstantiator`: Instantiators handle creating instances
+* `addPopulator`: Populators handle setting properties on instances
+
+All of the feature set of Alice 1.x that was previously in the `Loader` class has been pieced out into the handlers mentioned above - a quick glance at the class names will probably explain their purpose as well as any documentation could.