Suffix the namespace with Dev. Add the README file.

Author: ianef

.gitignore

@@ -4,7 +4,7 @@
 /vendor/
 
 # PHPStan extracted files
-/phpstan
+/phpstan/
 
 # PHPUnit
 /app/phpunit.xml

README.md

@@ -0,0 +1,27 @@
+# xactsystems/phpstan-dev
+
+Package to extract and provide PHPStan source code for developing custom rules.
+Author: Ian Foulds.
+
+PHPStan does not provide a method to load the source code via a package manager. Instead it needs extracting from the .phar archive.
+
+If you use PHPStorm of PHP Tools by DEVSENSE then this issue is covered, but not everyone does!
+
+Personally I think this whole approach goes against the ethos of a package manager, it should just be a package!
+
+So, I've created this composer plugin that required phpstan as a dependency, extracts the source code, and links the PHPStan namespace to it.
+
+## Installation
+To use this extension, require it in Composer:
+
+```bash
+composer require --dev xactsystems/phpstan-dev
+```
+
+## Usage
+
+This plugin will expose the \PHPStan namespace so that you can create your custom rules and collectors.
+
+See the following pages for more details:
+https://phpstan.org/developing-extensions/rules
+https://phpstan.org/developing-extensions/collectors

composer.json

@@ -11,7 +11,7 @@
     "license": "MIT",
     "autoload": {
         "psr-4": {
-            "Xact\\PHPStan\\": "src/",
+            "Xact\\PHPStan\\Dev\\": "src/",
             "PHPStan\\": "phpstan/src"
         }
     },

src/Plugin.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Xact\Phpstan;
+namespace Xact\Phpstan\Dev;
 
 use Composer\Composer;
 use Composer\InstalledVersions;