Skip to content

Commit 1d8e7d8

Browse files
committed
Added information about building Phar package.
1 parent 0f5f9fa commit 1d8e7d8

File tree

5 files changed

+222
-98
lines changed

5 files changed

+222
-98
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,20 @@ Check PHP files within a directory for appropriate use of PHPDocs (Docblocks). P
1010
composer require php-censor/phpdoc-checker
1111
```
1212

13+
## Building Phar Package
14+
15+
```bash
16+
box.phar compile
17+
```
18+
1319
## Usage
1420
**CMD**:<br>
1521

1622
```bash
1723
vendor/bin/phpdoc-checker {params}
1824
```
1925

20-
## Parameters
26+
### Parameters
2127

2228
Short | Long | Description
2329
------------ | ------------- | -----------

box.json renamed to box.json.dist

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"finder": [
1010
{
1111
"name": "*.php",
12-
"exclude": ["Tests"],
12+
"exclude": ["tests"],
1313
"in": "vendor"
1414
}
1515
],

composer.json

+1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
},
3232
"require": {
3333
"php": ">=7.1.0",
34+
"ext-json": "*",
3435
"nikic/php-parser": "^4.2",
3536
"symfony/console": "^4.3"
3637
},

0 commit comments

Comments
 (0)