Update readme

Signed-off-by: Prabhu Subramanian <[email protected]>
AppThreat · Oct 13, 2023 · d0726ec · d0726ec
1 parent 8d59ff2
commit d0726ec
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -28,6 +28,12 @@ npm install @appthreat/atom
 # sudo npm install -g @appthreat/atom
 ```
 
+Install cdxgen to generate a Software Bill-of-Materials which is required for certain slicing.
+
+```shell
+npm install -g @cyclonedx/cdxgen --omit=optional
+```
+
 ## CLI Usage
 
 ```
@@ -81,6 +87,14 @@ export ANDROID_HOME=<path to android sdk>
 atom -o app.atom -l apk <apk file>
 ```
 
+### Create reachables slice for a java project.
+
+```shell
+cd <path to repo>
+cdxgen -t java --deep -o bom.json .
+atom reachables -o app.atom -s reachables.json -l java .
+```
+
 ### Create data-flow slice for a java project.
 
 ```shell

diff --git a/wrapper/nodejs/package-lock.json b/wrapper/nodejs/package-lock.json
diff --git a/wrapper/nodejs/package.json b/wrapper/nodejs/package.json
@@ -14,7 +14,7 @@
     "yargs": "^17.7.2"
   },
   "devDependencies": {
-    "eslint": "^8.50.0"
+    "eslint": "^8.51.0"
   },
   "bin": {
     "atom": "./index.js",