From dbdf8bc88cac79c95de95d8d59d0ca074a88a813 Mon Sep 17 00:00:00 2001
From: Brendan McDevitt <brendan@mcdevitt.tech>
Date: Thu, 24 Feb 2022 01:06:59 -0600
Subject: [PATCH] update README to show usage/help

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index f51505a..c7ecd8e 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,16 @@ this token is used for wpscan db api calls. To use the container:
 # BUILD IT
 docker build -t wp_checker .
 
+# HELP / USAGE
+
+docker run --env-file .env wp_checker --help
+Usage: check_wp_vuln.sh <options> <plugin/theme/wpversion>
+options:
+ --help                 display this help page
+ --plugin               query api for a specific plugin
+ --theme                query api for specific theme
+ --all                  retrieve all vulnerabilities in a specific wp version number
+
 # PLUGIN
 docker run --env-file .env wp_checker --plugin jetpack