Create README.md

README.md

@@ -0,0 +1,48 @@
+# Debug Statements Fixers
+Fixers set for PHP-CS-Fixer. Removes debug statements, which shouldn't be in production ever. 
+
+If you have ever had 500 Error on production because `dump` function is missing, 
+or you forget to remove debug statements time to time - this small package is for you.
+
+Debug statements are good for debugging, but it should never get to master branch.
+
+Initially proposed as [RFC in PHP-CS-Fixer repository](https://github.com/FriendsOfPHP/PHP-CS-Fixer/issues/2195), 
+it was considered too risky to have it in core (see discussion at https://github.com/FriendsOfPHP/PHP-CS-Fixer/pull/2218)
+
+*N.B.* These fixers are risky and potentially can break your application. You should understand consequences of having it in your project (especially a legacy one). You are warned.
+
+
+## Usage
+
+1. Install it:
+
+    ```bash
+    $ composer require drew/debug-statements-fixers --dev
+    ```
+
+2. Adjust your PHP-CS-Fixer config:
+
+    ```php
+    # .php_cs.dist
+    <?php
+    
+    $finder = PhpCsFixer\Finder::create()
+        ->in([__DIR__.'/src', __DIR__.'/tests']);
+
+    return PhpCsFixer\Config::create()
+        ->setRules([
+            'RemoveDebugStatements/dump' => true,
+        ])
+        ->registerCustomFixers([new Drew\DebugStatementsFixers\Dump()])
+        ->setRiskyAllowed(true)
+        ->setFinder($finder);    
+    ```
+3. Enjoy.
+
+#### Protip!
+
+Works best when integrated with you CI server, just add this step to your CI config:
+
+```bash
+$ php vendor/bin/php-cs-fixer fix --diff --dry-run -v
+```