diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000000000000000000000000000000000000..44a73acb0d40f8cf7b24e7dad0650ffaeb81555d --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,4 @@ +# [1.0.0] - 2023-11-17 + +## Added +- Initial project release with basic configuration. diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..e4b8bd8206e27a42d98bbf9bbbead1f279113187 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Common PHPStan configuration for WP Desk + +This meta-package contains PHPStan configuration for WP Desk projects. This includes dependent extensions like `szepeviktor/phpstan-wordpress`, and additional, default configuration like inclusion of WooCommerce stubs. + +## Installation + +```sh +composer require wpdesk/phpstan-rules +``` + +## Usage + +After installation, you can simply use PHPStan in your project without the need to further configuration. Nevertheless, as project grows, it's worth to add even [the basic one](https://phpstan.org/config-reference). + +To run PHPStan, simply execute the following command (<path> is only required if not present in configuration file): + +```sh +vendor/bin/phpstan analyse <path> +```