Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

updated the README file

  • Loading branch information...
commit 941b1b969805b7d64732409a5443d410ba6ad37b 1 parent a6b69fb
@fabpot fabpot authored
Showing with 18 additions and 4 deletions.
  1. +18 −4 README.md
View
22 README.md
@@ -3,15 +3,28 @@ SensioLabs Security Checker
The SensioLabs Security Checker is a command line tool that checks if your
application uses dependencies with known security vulnerabilities. It uses the
-[SensioLabs Security Check Web service][1] and the [Security Advisories Database][2]
-behind the scenes:
+[SensioLabs Security Check Web service][1] and the [Security Advisories Database][2].
+Usage
+-----
+
+Download the [security-checker.phar][3] file:
+
+ $ php security-checker.phar security:check /path/to/composer.lock
+
+Use the code from the repository directly:
+
+ $ composer install
$ php security-checker security:check /path/to/composer.lock
-You can also integrate the checker in your own application/project
+Integration
+-----------
+
+The checker uses the Symfony Console component; so, you can easily integrate
+the checker into your own project:
* by using the `SecurityCheckerCommand` class into your Symfony Console
- application.
+ application;
* by using the `SecurityChecker` class directly into your own code:
@@ -22,3 +35,4 @@ You can also integrate the checker in your own application/project
[1]: http://security.sensiolabs.org/
[2]: https://github.com/sensiolabs/security-advisories
+[3]: http://get.sensiolabs.org/security-checker.phar
Please sign in to comment.
Something went wrong with that request. Please try again.