diff --git a/README.md b/README.md index 9350259..2dddd2c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # WordPress Vulnerability Check (wp-vulnerability-check) [![Build Status](https://travis-ci.org/umutphp/wp-vulnerability-check.svg?branch=master)](https://travis-ci.org/umutphp/wp-vulnerability-check) [![Latest Stable Version](https://poser.pugx.org/umutphp/wp-vulnerability-check/v/stable)](https://packagist.org/packages/umutphp/wp-vulnerability-check) [![Total Downloads](https://poser.pugx.org/umutphp/wp-vulnerability-check/downloads)](https://packagist.org/packages/umutphp/wp-vulnerability-check) [![Latest Unstable Version](https://poser.pugx.org/umutphp/wp-vulnerability-check/v/unstable)](https://packagist.org/packages/umutphp/wp-vulnerability-check) [![composer.lock](https://poser.pugx.org/umutphp/wp-vulnerability-check/composerlock)](https://packagist.org/packages/umutphp/wp-vulnerability-check) -Check the WPScan Vulnerability Database via API to identify the security issues of WordPress plugins installed. +A command line took to check the WPScan Vulnerability Database via API to identify the security issues of WordPress plugins installed. # Installation -It can be installed as a stand-alone tool (for CI etc) or a project dependency. +It can be installed as a stand-alone tool or used as a test on your CI pipeline. ``` composer require umutphp/wp-vulnerability-check --dev @@ -54,3 +54,18 @@ custom-css-js References: https://jvn.jp/en/jp/JVN31459091/index.html, https://plugins.trac.wordpress.org/changeset/1695440/#file6 ``` + +A sample execution without vulnerability details; + +``` +$ ./wp-vulnerability-check --path /path/to/plugins/ --token token + +Checking plugins... + +.V... + +Checked 5 plugins in 1.5 second, found some vulnerability(s) in 1 plugin. + +The plugin which is not in WPScan Vulnerability Database; hello. +PS: You can exclude your custom plugins with --exclude parameter. +```