Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
umutphp committed Jan 23, 2019
1 parent 9dad831 commit bc5e7c6
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.
```

0 comments on commit bc5e7c6

Please sign in to comment.