Skip to content
This repository was archived by the owner on Feb 6, 2023. It is now read-only.

Commit e01bea2

Browse files
committed
Improve README.md
Improve description, add **Installation**, **Usage** and **Issues**.
1 parent 37e740c commit e01bea2

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,42 @@
11
# composer-audit
2-
A composer plugin that checks if your application uses dependencies with known security vulnerabilities (it uses SensioLabs Security Checker)
2+
A composer plugin that checks if your application uses dependencies with known security vulnerabilities (it uses [SensioLabs Security Checker][1]).
3+
4+
## Installation
5+
Using the `composer` command:
6+
7+
$ composer require davidepastore/composer-audit:0.1.0
8+
9+
Manually adding in composer.json:
10+
11+
{
12+
"require": {
13+
"davidepastore/composer-audit": "0.1.0"
14+
}
15+
}
16+
17+
## Usage
18+
The checker will be executed when you launch `composer install` or `composer update`.
19+
If you have alerts in your composer.lock, `composer-audit` will print them. An example could be this:
20+
21+
ALERTS from SensioLabs security advisories.
22+
23+
*** dompdf/dompdf[v0.6.0] ***
24+
25+
* dompdf/dompdf/CVE-2014-2383.yaml
26+
Arbitrary file read in dompdf
27+
https://www.portcullis-security.com/security-research-and-downloads/security-advisories/cve-2014-2383/
28+
CVE-2014-2383
29+
30+
31+
Please fix these alerts from SensioLabs security advisories.
32+
33+
If no alert is found, you'll get this:
34+
35+
All good from SensioLabs security advisories.
36+
37+
## Issues
38+
39+
If you have issues, just open one [here][2].
40+
41+
[1]: https://github.com/sensiolabs/security-checker
42+
[2]: https://github.com/DavidePastore/composer-audit/issues

0 commit comments

Comments
 (0)