Skip to content

Commit 658d41e

Browse files
committed
Update README.md
1 parent 75cb2ca commit 658d41e

1 file changed

Lines changed: 20 additions & 3 deletions

File tree

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
# GitHub Action for PHP syntax check
1+
# PHP Lint GitHub Action
22

3-
This actions runs `php -l` on all PHP files found in the current project. It allows you to easily and quickly check for
3+
This Github Action runs `php -l` on all PHP files found in the current project. It allows you to easily and quickly check for
44
any syntax / parse errors in your PHP files on pull requests or pushes. This is especially useful for code that is
55
meant to run on multiple PHP versions.
66

7+
---
8+
79
## Getting Started
810

9-
Using this action can be done with this template:
11+
Using this action can be done with the following template:
1012

1113
```
1214
steps:
@@ -28,6 +30,8 @@ steps:
2830
folder-to-exclude: "! -path \"./vendor/*\" ! -path \"./folder/excluded/*\""
2931
```
3032

33+
---
34+
3135
## Brand New Setup
3236

3337
If you have never used github actions, then create a file called phplint.yml in your Git repository in the directory
@@ -67,6 +71,19 @@ In the above example, your workflow will run the PHP syntax check with PHP 5.6,
6771

6872
---
6973

74+
## Supported versions
75+
76+
Right now there is support for the following PHP versions:
77+
- 5.5
78+
- 5.6
79+
- 7.2
80+
- 7.3
81+
- 7.4
82+
83+
If you would like to add more submit a PR or an issue.
84+
85+
---
86+
7087
## Ignoring paths
7188

7289
You can see in the above examples it ignores certain paths. You may add as many as you need by copying the example.

0 commit comments

Comments
 (0)