Merge pull request #8 from nucleus-security/develop

Added README
brettwilcox · Dec 16, 2021 · d1bcd0d · d1bcd0d
2 parents faeba84 + 65d293f
commit d1bcd0d
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/Vdoo/README.md b/Vdoo/README.md
@@ -0,0 +1,12 @@
+Setup:
+Install the required packages in requirements.txt file
+Install python 3
+
+Update the following global variables:
+
+NUCLEUS_ROOT_URL = set it to your Nucleus root url of your instance
+API_KEY = "c331319223bb9xxxxxxxxxxxxxxxxxxx" - generate it in the Nucleus UI
+PROJECT_ID = '<int>' - Find in Nucleus on global dashboard > projects list (id)
+
+VDOO_KEY = Generate an API key through the VDoo UI
+VDOO_ROOT_URL = "https://prod.vdoo.io"