diff --git a/README.md b/README.md index f5d81b2..eb4198f 100644 --- a/README.md +++ b/README.md @@ -1 +1,30 @@ -# Stubs (for PHPstan) +# Stubs (for PHPstan)\ + +[![Continuous Integration](https://github.com/reactphp-parallel/stubs/actions/workflows/ci.yml/badge.svg)](https://github.com/reactphp-parallel/stubs/actions) +[![Latest Stable Version](https://poser.pugx.org/react-parallel/stubs/v/stable)](https://packagist.org/packages/react-parallel/stubs) +[![License](https://poser.pugx.org/react-parallel/stubs/license)](https://packagist.org/packages/react-parallel/stubs) + +* [PHPStan](https://phpstan.org/) +* [ext-parallel](https://github.com/krakjoe/parallel) + +## Installation + +To use this extension, require it in [Composer](https://getcomposer.org/): + +``` +composer require --dev react-parallel/stubs +``` + +If you also install [phpstan/extension-installer](https://github.com/phpstan/extension-installer) then you're all set! + +
+ Manual installation + +If you don't want to use `phpstan/extension-installer`, include extension.neon in your project's PHPStan config: + +``` +includes: + - vendor/react-parallel/stubs/extension.neon +``` + +