Skip to content
This repository was archived by the owner on Jan 3, 2024. It is now read-only.

Commit 3266c59

Browse files
authored
Merge pull request #4 from cprn/main
Updated docs to show `$COMPOSER_BIN` usage and `bin-dir` support.
2 parents 40dc85e + 445d3b0 commit 3266c59

1 file changed

Lines changed: 11 additions & 4 deletions

File tree

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,31 @@
11
# local-php-security-checker-installer
22
Composer integration for local PHP security check using fabpot/local-php-security-checker
33

4-
Install:
4+
## Install:
55

66
```
77
composer require thibautselingue/local-php-security-checker-installer
88
```
99

10-
Usage:
10+
Binary will be downloaded to your project's bin directory (`vendor/bin` by default, see [documentation](https://getcomposer.org/doc/articles/vendor-binaries.md#can-vendor-binaries-be-installed-somewhere-other-than-vendor-bin-)).
11+
12+
## Usage:
1113

1214
```
1315
vendor/bin/local-php-security-checker-installer && vendor/bin/local-php-security-checker
1416
```
1517

16-
Example in composer.json auto-scripts:
18+
Example passing path to Composer binary:
19+
```
20+
COMPOSER_BIN=./composer.phar vendor/bin/local-php-security-checker-installer && vendor/bin/local-php-security-checker
21+
```
22+
23+
Example in `composer.json` auto-scripts:
1724

1825
```
1926
"scripts": {
2027
"auto-scripts": {
2128
"local-php-security-checker-installer && local-php-security-checker": "script"
2229
}
2330
}
24-
```
31+
```

0 commit comments

Comments
 (0)