diff --git a/README.md b/README.md index 9c9ca64..c6a28ba 100644 --- a/README.md +++ b/README.md @@ -1 +1,11 @@ # php-lint-workflow-guide + +This repository serves as an example PHP project with the CI setup done for performing linting and code analysis as part of PHP coding standards check. + +This project is based on the Symfony (v6.3) framework and created on a system with PHP 8.2. + +The configuration for the CI workflow, PHPCS and Phan are in the following files: + +- `.github/workflows/php-lint.yml`: Configuration for the CI workflow +- `.phan/config.php`: Configuration for Phan +- `.phpcs.xml`: Configuration for PHPCS