Update README.md

brettwilcox · Aug 23, 2019 · ebe4a75 · ebe4a75
1 parent b5bbba7
commit ebe4a75
Showing 1 changed file with 7 additions and 5 deletions.
diff --git a/arachni/README.md b/arachni/README.md
@@ -1,16 +1,18 @@
+This script is a command line tool for easily converting arachni json output into a Nucleus format for easy upload into Nucleus. 
+
+
 Install:
 
 Need to install python3 and the requests library
 
 
-Usage:
 
-CLI tool
+Usage:
 
-python arachni_json_parse.py -i <arachni json input file> -o <nucleus json outputfile>
+python arachni_json_parse.py -i {arachni json input file} -o {nucleus json outputfile}
 
-Optional: -# <Project ID of the Nucleus project to which you want to upload the outputfile>
+Optional: -# {Project ID of the Nucleus project to which you want to upload the outputfile}
 
 If a project ID is not specified, the script will just create a json file in the local directory. If a project ID is specified, then will post the Nucleus outputfile to that Nucleus project.
 
-Note: If you want to post the file to Nucleus you will need to get an API key from the Nucleus console and update the NUCLEUS_ROOT_URL in the python script.
+Note: If you want to post the file to Nucleus you will need to get an API key from the Nucleus console and update the NUCLEUS_ROOT_URL in the python script.