Skip to content

Commit 6a5ed27

Browse files
authored
docs: updated README.md
1 parent 40c80b3 commit 6a5ed27

1 file changed

Lines changed: 13 additions & 19 deletions

File tree

README.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,23 @@
11
# PHP Skeleton
22

3+
34
> An application skeleton for modern PHP projects.
45
6+
57
[TOC]
68

9+
710
## Summary
811

912
This repository contains an application skeleton following best practices.
1013

1114

12-
1315
### Highlights
1416

1517
- Unified environment to build CLI, web applications and/or microservices based on **PHP8**.
1618
- Includes **PCOV**, **PHPCS/PHPCBF**, **PHPUnit**, **UOPZ**, **PHPStan** and a **linter** by default.
1719

1820

19-
2021
## Requirements
2122

2223
To use this repository you need:
@@ -31,18 +32,16 @@ To use this repository you need:
3132
- [PCOV](https://github.com/krakjoe/pcov) - In order to generate the PHP code coverage report
3233

3334

34-
3535
## Built with
3636

37-
| Type | Component | Description |
38-
| ----------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
39-
| Service | [PHP-FPM](https://www.php.net/manual/en/install.fpm.php) | PHP with FastCGI Process Manager |
40-
| Miscelaneous | [Make](https://www.gnu.org/software/make/) | Allows to execute commands defined on a _Makefile_ |
41-
| Quality Assurance | [PHP-Parallel-Lint](https://github.com/php-parallel-lint/PHP-Parallel-Lint) | Allows to check the syntax of PHP files in parallel |
42-
| Quality Assurance | [PHPCS/PHPCBF](https://github.com/PHPCSStandards/PHP_CodeSniffer/) | Allows to check and fix coding style issues |
43-
| Quality Assurance | [PHPStan](https://phpstan.org/) | Allows to perform static analysis of your application looking for issues |
44-
| Quality Assurance | [PHPUnit](https://phpunit.de/) | The PHP Testing Framework |
45-
37+
| Type | Component | Description |
38+
| ----------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
39+
| Service | [PHP-FPM](https://www.php.net/manual/en/install.fpm.php) | PHP with FastCGI Process Manager |
40+
| Miscelaneous | [Make](https://www.gnu.org/software/make/) | Allows to execute commands defined on a _Makefile_ |
41+
| Quality Assurance | [PHP-Parallel-Lint](https://github.com/php-parallel-lint/PHP-Parallel-Lint) | Allows to check the syntax of PHP files in parallel |
42+
| Quality Assurance | [PHPCS/PHPCBF](https://github.com/PHPCSStandards/PHP_CodeSniffer/) | Allows to check and fix coding style issues |
43+
| Quality Assurance | [PHPStan](https://phpstan.org/) | Allows to perform static analysis of your application looking for issues |
44+
| Quality Assurance | [PHPUnit](https://phpunit.de/) | The PHP Testing Framework |
4645

4746

4847
## Getting Started
@@ -71,6 +70,7 @@ $ git clone git@github.com:fonil/php-skeleton.git .
7170
├── composer.lock # Composer lock file
7271
├── LICENSE # License document
7372
├── Makefile # Makefile with frequent commands
73+
├── phpcs.xml # PHPCS configuration file
7474
├── phpstan.neon # PHPStan configuration file
7575
├── phpunit.xml # PHPUnit configuration file
7676
└── README.md # This document
@@ -121,9 +121,7 @@ Additionally a *Makefile* is provided with frequently used commands:
121121
```
122122

123123

124-
125-
> This file is really useful when you create a container with a project based on this repository, and you want to run those commands from outside the container. To do so just copy and paste the included steps on your main *Makefile* and adjust the constants accordingly.
126-
124+
> This file is really useful when you create a container with a project based on this repository and you want to run those commands from outside the container, directly from your *host*. To do so just copy and paste the included steps on your main *Makefile* and adjust the constants accordingly.
127125
128126

129127
#### Volumes
@@ -133,9 +131,7 @@ Additionally a *Makefile* is provided with frequently used commands:
133131
Coverage report in HTML is generated on a root folder `/coverage`
134132

135133

136-
137134
> If you want the report is generated on a different path, just update accordingly the `composer.json` file under the section `scripts`
138-
139135
140136

141137
## Security Vulnerabilities
@@ -152,8 +148,6 @@ Only the latest major version receives security fixes.
152148

153149
If you discover a security vulnerability within this project, please [open an issue here](https://github.com/fonil/php-skeleton/issues). All security vulnerabilities will be promptly addressed.
154150

155-
156-
157151
## License
158152

159153
The MIT License (MIT). Please see [LICENSE](./LICENSE) file for more information.

0 commit comments

Comments
 (0)