updated readme

README.md

@@ -1,6 +1,8 @@
 # serialize-debugger
 
-A tool for debugging failing or dangerous PHP serialize() calls
+A tool for debugging failing or dangerous PHP serialize() calls.
+
+# Motivation
 
 Debugging issues with PHP's `serialize()` method can be a tedious task, because it doesn't give much information when it
 encounters errors. This is best demonstrated with an example:
@@ -45,4 +47,41 @@ Closure - ERROR
     {root}[foo]->invalidProp
 ```
 
-Much better, now we know exactly where the offending closure is located in the problematic data structure.
+Much better, now we know exactly where the offending closure is located in the problematic data structure.
+
+# Requirements
+
+serialize-debugger is only supported on PHP 5.4.0 and up.
+
+# Installation
+
+Using composer, add to your composer.json:
+```
+"edemeijer/serialize-debugger": ">=0.1.1"
+```
+Then run `composer.phar update`
+#API
+Basic usage:
+```php
+// There are two static convenience methods in the main debugger class:
+// Outputting errors and warnings in plain text format
+Debugger::debugPlaintext($data);
+
+// Outputting errors and warnings in HTML format
+Debugger::debugHTML($data);
+
+// Both methods provide an optional second boolean parameter for verbose output
+// This will output not only errors and warnings, but the paths to every element
+// in the data set
+Debugger::debugPlainText($data, true);
+```
+Without using the static convenience methods:
+```php
+$debugger = new Debugger();
+$formatter = new PlainTextFormatter();
+$result = $debugger->getDebugResult($data, $verbose);
+echo $formatter->format($result);
+```
+
+# License
+MIT - See LICENSE file.