Update readme.md file

Author: Jaspaul

readme.md

@@ -4,3 +4,90 @@ Formatter Bundle
 [![Build Status](https://travis-ci.org/SoapBox/laravel-formatter.svg?branch=master)](https://travis-ci.org/SoapBox/laravel-formatter)
 
 A formatter package that will help you to easily convert between various formats such as XML, JSON, CSV, etc...
+
+# Goals
+The goals of this library to to allow the transfomation of data formats from one type to another. See Parsers and Formats to see supported input / output formats.
+
+# Installation
+
+Through command line:
+
+```bash
+composer require soapbox/laravel-formatter
+```
+
+Through composer.json:
+
+```json
+{
+	"require": {
+		"soapbox/laravel-formatter": "2.x"
+	}
+}
+
+```
+
+## Parsers
+All of the following are supported formats that the formatter can read from.
+* Array
+* CSV
+* JSON
+* XML
+* YAML
+
+## Formats
+All of the following are formats that are supported for output.
+* Array
+* CSV
+* JSON
+* XML
+* YAML
+
+## General Usage (See tests for most up to date examples)
+
+__Including The Formatter__
+
+```php
+use SoapBox\Formatter\Formatter;
+```
+
+__Supported Types__
+
+```php
+Formatter::JSON; //json
+Formatter::CSV;  //csv
+Formatter::XML;  //xml
+Formatter::ARR;  //array
+Formatter::YAML; //yaml
+```
+
+__Making Your First Formatter__
+
+```php
+$formatter = Formatter::make($jsonString, Formatter::JSON);
+```
+
+__Outputting From Your Formatter__
+
+```php
+$csv = $formatter->toCsv();
+$json = $formatter->toJson();
+$xml = $formatter->toXml();
+$array = $formatter->toArray();
+$yaml = $formatter->toYaml();
+```
+
+## Deprecated Functionality
+The following have been deprecated from the library, however you can easily continue using them in your application
+
+__Serialized Array__
+
+```php
+$serialized = serialize($formatter->toArray());
+```
+
+__PHP Export__
+
+```php
+$export = var_export($formatter->toArray());
+```