Merge pull request #1 from devdrops/develop

Merged #1

Author: devdrops

.gitignore

@@ -1,2 +1,2 @@
-.idea
-vendor
+/composer.lock
+/vendor

README.md

@@ -0,0 +1,24 @@
+##PHP DocBlock Checker
+
+A basic CLI (Command Line Interface) tool to verify if your PHP classes have DocBlocks.
+
+###What it does?
+
+This tool can:
+
+ - Check if every PHP class and it's methods does have their own DocBlock.
+
+###What it does not?
+ - It doesn't check for the integrity of your DocBlocks **at this time**.
+
+###What does it requires?
+Please check `composer.json` for details.
+
+###Where is the documentation?
+Please check `docs.md` for further information on how to use this tool.
+
+###And, in case I want some references?
+
+ - [phpDocumentor list of DocBlock tags](http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.pkg.html)
+ - [Project source](https://github.com/Block8/php-docblock-checker)
+ - [PSR-5 PHPDoc Standard [**DRAFT**]](https://github.com/php-fig/fig-standards/pull/169/files)

composer.json

@@ -6,7 +6,6 @@
     "keywords"         : ["php", "phpci", "testing", "docblock", "comment", "checker", "code quality"],
     "homepage"         : "https://www.phptesting.org/",
     "license"          : "BSD-2-Clause",
-
     "authors": [
         {
             "name"    : "Dan Cryer",
@@ -15,25 +14,29 @@
             "role"    : "Developer"
         }
     ],
-
     "support": {
         "issues": "https://github.com/Block8/php-docblock-checker/issues",
         "source": "https://github.com/Block8/php-docblock-checker"
     },
-
     "require": {
         "php": ">=5.3.3",
         "phpunit/php-token-stream": "1.*",
         "symfony/console": "~2.1"
     },
-
     "require-dev": {
         "phpmd/phpmd": "~2.0",
         "squizlabs/php_codesniffer": "~1.5",
         "phploc/phploc": "~2.0"
     },
-
     "bin": [
         "phpdoccheck"
-    ]
+    ],
+    "autoload": {
+        "psr-0": {
+            "PhpDocblockChecker": "src/"
+        },
+        "psr-4": {
+            "PhpDocblockChecker\\": "src/"
+        }
+    }
 }