summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c9df967
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# cve-checker
+VyOS security vulnerability checker
+
+What is this?
+This is a utility for obtaining information about possible vulnerabilities
+
+Modules that require an API key:
+vulners
+(To get the API key, you need to register on the website https://vulners.com/ and generate new key here https://vulners.com/userinfo)
+
+Install and dependencies:
+Python 3.7+
+MongoDB 4.2+