Write documentation.

Author: tabennett

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013 CodeSleeve
+Copyright (c) 2013 Travis Bennett
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

README.md

@@ -19,6 +19,7 @@ Install the package using Composer.  Edit your project's `composer.json` file to
 ```
 
 ## Quickstart
+### Step 1 - Fixture setup
 Inside your application test folder, create a folder named fixtures.  Next, create a couple of fixture files inside this folder.  Fixture files are written using native php array syntax.  To create one, simply create a new file named after the table that the fixture corresponds to and have it return an array of data.  As an example of this, let's create some fixture data for a hypothetical 'soul_reapers' table (bear with me, I'm a huge Bleach fan):
 
 in tests/fixtures/soul_reapers.php
@@ -53,7 +54,7 @@ in tests/fixtures/zanpakutos.php
 			'name' => 'Zabimaru',
 		),
 		'Ryujin Jakka' => array(
-			'soul_reaper_id' => 'Yammamoto',
+			'soul_reaper_id' => 'Genryusai',
 			'name' => 'Ryujin Jakka',
 		)
 	);
@@ -90,7 +91,7 @@ in tests/fixtures/ranks_soul_reapers.php
 		),
 		'CaptainYammamoto' => array (
 			'soul_reaper_id' => 'Yammamoto',
-			'rank_id' 		=> 'Captain'
+			'rank_id' 		 => 'Captain'
 		),
 		'LieutenantAbari' => array (
 			'soul_reaper_id' => 'Renji',
@@ -103,3 +104,52 @@ in tests/fixtures/ranks_soul_reapers.php
 	);
 ```
 
+Notice that we have both a 'CommanderYammamoto' and a 'CaptainYammamoto' entry inside our ranks_soul_reapers join table; That's because Genryusai Yammamoto was the Captain Commander (he had both the commander role and was also captain level as well) of the Gotei 13. 
+
+### Step 2 - Initialize an instance of the fixture class.
+Now that the fixture files have been created, the next step is to create an instance of the fixture library inside of our unit tests.  Consider the following test (we're using PHPUnit here, but the testing framework doesn't matter; SimpleTest would work just as well):
+
+in tests/exampleTest.php
+```php
+	<?php
+
+		use Codesleeve\Fixture\Fixture;
+		use Codesleeve\Fixture\Repositories\StandardRepository;
+
+		class ExampleTest extends PHPUnit_Framework_TestCase {
+
+			protected $fixture;
+			protected $repository;
+
+			public function setUp()
+			{
+				if (!$this->repository) 
+				{
+					$pdo = new pdo();
+					$this->repository =  new StandardRepository($pdo);
+				}
+
+				$this->fixture = Fixture::getInstance();
+				$this->fixture->setRepository($this->repository);
+				$this->fixture->setConfig(array('location' => ''));
+				$this->fixture->up();
+			}
+
+			public function tearDown()
+			{
+				$this->fixture->down();
+			}
+		}
+	?>
+```
+
+What's going on here?  A few things:
+* We're creating an instance of 'Codesleeve\Fixture\Repositories\StandardRepository' and caching it as a property on the test class.
+** This is the most basic repository avaialble for this package.  It requires no ORM and has no concept of relationships.
+** In order to create a new repository we first need to instantiate a PDO database connection object and pass it as a parameter to the StandardRepository constructor.
+* We're creating a new instance of fixture via the getInstance() method (this is a singleton pattern).
+* We're injecting the stnadardRepository object into the fixture instance via the setRepository() method.
+* We're injecting in a configuration array with a location parameter that contains the file system location of the folder we want to load our fixtures from.
+* We're invoking the up() method on the fixture object.  This method seeds the database and caches the inserted records as php standard objects on the fixture object.
+** Invoking the up method with no params will seed all fixtures.
+** Invoking the up method with an array of fixture names will seed only those fixtures (e.g $this->fixture->up(['soul_reapers']) would seed the soul_reapers table only).