change: update readme & docs

Author: Matthias Leutenegger

README.md

@@ -1,40 +1,35 @@
 # PHPStan for Silverstripe
 
-[![Build Status](https://travis-ci.org/symbiote/silverstripe-phpstan.svg?branch=master)](https://travis-ci.org/symbiote/silverstripe-phpstan)
-[![Latest Stable Version](https://poser.pugx.org/symbiote/silverstripe-phpstan/version.svg)](https://github.com/symbiote/silverstripe-phpstan/releases)
-[![Latest Unstable Version](https://poser.pugx.org/symbiote/silverstripe-phpstan/v/unstable.svg)](https://packagist.org/packages/symbiote/silverstripe-phpstan)
-[![Total Downloads](https://poser.pugx.org/symbiote/silverstripe-phpstan/downloads.svg)](https://packagist.org/packages/symbiote/silverstripe-phpstan)
-[![License](https://poser.pugx.org/symbiote/silverstripe-phpstan/license.svg)](https://github.com/symbiote/silverstripe-phpstan/blob/master/LICENSE.md)
+A module allowing PHPStan to work with Silverstripe
+
+[![🎭 Tests](https://github.com/syntro-opensource/silverstripe-phpstan/workflows/%F0%9F%8E%AD%20Tests/badge.svg)](https://github.com/syntro-opensource/silverstripe-phpstan/actions?query=workflow%3A%22%F0%9F%8E%AD+Tests%22+branch%3A%22master%22)
+[![codecov](https://codecov.io/gh/syntro-opensource/silverstripe-phpstan/branch/master/graph/badge.svg)](https://codecov.io/gh/syntro-opensource/silverstripe-phpstan)
+![Dependabot](https://img.shields.io/badge/dependabot-active-brightgreen?logo=dependabot)
+[![phpstan](https://img.shields.io/badge/PHPStan-enabled-success)](https://github.com/phpstan/phpstan)
+[![composer](https://img.shields.io/packagist/dt/syntro/silverstripe-phpstan?color=success&logo=composer)](https://packagist.org/packages/syntro/silverstripe-phpstan)
+[![Packagist Version](https://img.shields.io/packagist/v/syntro/silverstripe-phpstan?label=stable&logo=composer)](https://packagist.org/packages/syntro/silverstripe-phpstan)
 
-An extension for PHPStan to allow it to reason about SilverStripe functionality.
 
 **Features:**
 
 - Support for `DataObject::get()`, ie. it understands you have a DataList of iterable SiteTree records.
 - Support for DataObject `db`, `has_one`, `has_many` and `many_many` magic properties and methods, ie. it knows SiteTree::Title is a string, that SiteTree::ParentID is an integer and that SiteTree::Parent() is a SiteTree record.
 - Support for `singleton('SiteTree')` and `Injector::inst()->get('SiteTree')`, ie. it knows these will return "SiteTree". If you override these with the injector, it'll also know what class you're actually using.
+- Support for config properties
 
 This PHPStan module is able to reason about extensions installed specific to your project as it bootstraps the SilverStripe config system. So if you've added an extension to your `Page` object that adds an additional `db` field, PHPStan will be able to reason about it.
 
 ## Composer Install
 
-SilverStripe 3.X
-```
-composer require --dev symbiote/silverstripe-phpstan:1.0.0 phpstan/phpstan-shim:0.9.2
-```
-
 SilverStripe 4.X
 ```
-composer require --dev symbiote/silverstripe-phpstan
+composer require --dev syntro/silverstripe-phpstan
 ```
 
-NOTE: Versions of PHPStan less than 0.12, we recommend installing the phpstan-shim as currently in SilverStripe 3.X,
-the QueuedJobs module's dependence on superclosure forces the PHP-Parser dependency of PHPStan to be at a very outdated
-version. From 0.12, the 'shim' install is the dfeault.
 
 ## Requirements
 
-* SilverStripe 3.1+
+* SilverStripe 4.3+
 
 ## Documentation
 
@@ -45,8 +40,3 @@ version. From 0.12, the 'shim' install is the dfeault.
 ## Known Limitations
 
 * The type of the `owner` property can't be reasoned about for extensions. You must use `getOwner()`. Related Issues: [#1043](https://github.com/phpstan/phpstan/issues/1043) and [#1044](https://github.com/phpstan/phpstan/issues/1044)
-
-## Credits
-
-* [Ondřej Mirtes](https://github.com/ondrejmirtes) for his amazing work on the PHPStan library
-* [Grant Lucas](https://github.com/symbiote/silverstripe-phpstan/pull/8) for his contribution to this library by upgrading it to PHPStan 0.9

docs/en/advanced-usage.md

@@ -7,7 +7,7 @@ parameters:
     ignoreErrors:
         # Most QueuedJobs don't call the parent::__construct() method
         - '#does not call parent constructor from AbstractQueuedJob#'
-        
+
         # SS_List is basically ArrayList and DataList. Consider filter/sort/etc supported.
         - '#Call to an undefined method SS_List::#'
 includes:
@@ -26,12 +26,12 @@ NOTE: The '.' in the above command means it'll output the files in the current d
 
 3) Execute the following from the project directory to run tests:
 ```
-vendor/bin/phpunit -c vendor/symbiote/silverstripe-phpstan/tests/phpunit.xml vendor/symbiote/silverstripe-phpstan/tests/
+vendor/bin/phpunit -c vendor/syntro/silverstripe-phpstan/tests/phpunit.xml vendor/symbiote/silverstripe-phpstan/tests/
 ```
 
 # Debugging
 
 By adding --debug to the list of parameters, you can make PHPStan crash when it hits an error.
 This is incredibly useful for PRs or helping raise issues.
 
-`./vendor/bin/phpstan.phar.bat analyse ptv-mpw/src -c "phpstan.neon" -a "vendor/symbiote/silverstripe-phpstan/bootstrap.php" --level 2 --debug`
+`./vendor/bin/phpstan.phar.bat analyse ptv-mpw/src -c "phpstan.neon" -a "vendor/symbiote/silverstripe-phpstan/bootstrap.php" --level 2 --debug`

docs/en/quick-start.md

@@ -3,13 +3,12 @@
 1. Create "phpstan.neon" in project directory. For more configuration options, see [Advanced Usage](/docs/en/advanced-usage.md).
 ```
 includes:
-    - vendor/symbiote/silverstripe-phpstan/phpstan.neon
+    - vendor/syntro/silverstripe-phpstan/phpstan.neon
 ```
 
 2. Execute from project dir:
 ```
-vendor/bin/phpstan analyse mysite/code -c phpstan.neon -a vendor/symbiote/silverstripe-phpstan/bootstrap.php --level 2
+vendor/bin/phpstan analyse app/src -c phpstan.neon -a vendor/symbiote/silverstripe-phpstan/bootstrap.php --level 4
 ```
 
 3. Visit the [PHPStan Github](https://github.com/phpstan/phpstan) for additional information. Try adjusting the `--level`, lower = less strict, higher = more strict.
-