From 663df2c65b842c2b50c8fffa4aa87078fed1975f Mon Sep 17 00:00:00 2001
From: Mike van Riel <mike.vanriel@naenius.com>
Date: Sat, 26 May 2012 10:28:28 +0200
Subject: [PATCH] Expanded README file and added Markdown class as dependency
 since it is used in the long description and parameter parsing

---
 README.md     | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++
 composer.json |  3 ++-
 2 files changed, 59 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e69de29..8752a9a 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,57 @@
+The ReflectionDocBlock Component
+================================
+
+Introduction
+------------
+
+The ReflectionDocBlock component of phpDocumentor provides a DocBlock parser
+that is 100% compatible with the [PHPDoc standard](http://phpdoc.org/docs/latest).
+
+With this component can a library provide support for annotations via DocBlocks
+or otherwise retrieve information that is embedded in a DocBlock.
+
+> **Note**: *this is a core component of phpDocumentor and is constantly being
+> optimized for performance.*
+
+Installation
+------------
+
+You can install the component in the following ways:
+
+* Use the official Github repository (https://github.com/phpDocumentor/ReflectionDocBlock)
+* Via composer (add the Github Repository as VCS repository in your composer.yml)
+
+Usage
+-----
+
+The ReflectionDocBlock component is designed to work in an identical fashion to
+PHP's own Reflection extension (http://php.net/manual/en/book.reflection.php).
+
+Parsing can be initiated by instantiating the
+`\phpDocumentor\Reflection\DocBlock()` class and passing it a string containing
+a DocBlock (including asterisks) or by passing an object supporting the
+`getDocComment()` method.
+
+> *Examples of objects having the `getDocComment()` method are the
+> `ReflectionClass` and the `ReflectionMethod` classes of the PHP
+> Reflection extension*
+
+Example:
+
+    $class = new ReflectionClass('MyClass');
+    $phpdoc = new \phpDocumentor\Reflection\DocBlock($class);
+
+or
+
+    $docblock = <<<DOCBLOCK
+    /**
+     * This is a short description.
+     *
+     * This is a *long* description.
+     *
+     * @return void
+     */
+    DOCBLOCK;
+
+    $phpdoc = new \phpDocumentor\Reflection\DocBlock($docblock);
+
diff --git a/composer.json b/composer.json
index 73a5ee9..d4b6418 100644
--- a/composer.json
+++ b/composer.json
@@ -6,7 +6,8 @@
         {"name": "Mike van Riel", "email": "mike.vanriel@naenius.com"}
     ],
     "require": {
-        "php": ">=5.3.2"
+        "php": ">=5.3.2",
+        "dflydev/markdown": "1.0.*"
     },
     "autoload": {
         "psr-0": {"phpDocumentor\\Reflection": "src/"}