update docs

Author: BioPhoton

README.md

@@ -1,19 +1,26 @@
 # Advanced Performance profiling for Nx
 
-| Default                                                  | Advanced                                                                   |
-|----------------------------------------------------------|----------------------------------------------------------------------------|
-| ![flame-charts.png](./tools/imgs/nx-default-profile.png) | ![flame-charts.png](./tools/imgs/main-and-forked-process-flame-charts.png) |
+| Default                                                                | Advanced                                                                   |
+| ---------------------------------------------------------------------- | -------------------------------------------------------------------------- |
+| ![flame-charts.png](./tools/imgs/nx-default-profile.png)               | ![flame-charts.png](./tools/imgs/main-and-forked-process-flame-charts.png) |
 | `NX_DAEMON=false NX_PERF_LOGGING=true NX_CACHE=false nx show projects` | `node ./nx-advanced-profile.js --args=show,projects`                       |
 
+Nx it boosting performance, yet when there is a question, it is not always easy to understand where the time is spent.
+By default, Nx provides a way to profile the performance of the CLI commands using `NX_PERF_LOGGING=true` and `NX_DAEMON=false`.
+This will create a minimal text log in the terminal.
+
+This script provides a way to profile the performance of the Nx CLI commands in high detail and in a great UI, the Chrome DevTools.
+It will create a flame graph that shows the time spent in each function and the call stack, including the ones from child processes
+
 ## Main Process Logging
 
 1. Copy the `tools` folder into your workspace root.
 2. Run `node ./tools/nx-advanced-profile.bin.js`.  
    The script will create a file named `.nx-profiling/nx-show-projects.<Date.now()>.profile.json`.
 3. Open Chrome browser
-   1. Open DevTools (F12)
+   1. Open DevTools
    2. Go to the `Performance` tab
-4. Drag and drop the `<process>.profile.json` file into the DevTools window.
+   3. Drag and drop the `<process>.profile.json` file into the DevTools window.
 
 ![flame-charts.png](./tools/imgs/main-process-flame-charts.png)
 
@@ -22,14 +29,14 @@
 1. Run `node ./tools/nx-advanced-profile.postinstall.js`. This modifies the Nx sourcecode to be patched. (Don't forget
    to revert your changes)
 2. Run `node ./tools/nx-advanced-profile.bin.js --noPatch`. (As it is now patched inside the file directly)
-3. Drag and drop the `<process>.profile.json` file into the DevTools window.
+3. Open DevTools
 
 ![flame-charts.png](./tools/imgs/main-and-forked-process-flame-charts.png)
 
 ## Terminal Arguments
 
 | Option      | Shorthand | Description                             |
-|-------------|-----------|-----------------------------------------|
+| ----------- | --------- | --------------------------------------- |
 | `--args`    |           | comma separated process args `-t,build` |
 | `--verbose` | `-v`      | Show verbose output                     |
 | `--noPatch` | `-p`      | Don't patch the Nx sourcecode           |
@@ -41,4 +48,3 @@
 ```sh
 node ./tools/nx-advanced-profile.bin.js --verbose --noPatch --outDir=./tools/demo --outFile=nx-show-projects
 ```
-

nx.json

@@ -1,10 +1,7 @@
 {
   "$schema": "./node_modules/nx/schemas/nx-schema.json",
   "namedInputs": {
-    "default": [
-      "{projectRoot}/**/*",
-      "sharedGlobals"
-    ],
+    "default": ["{projectRoot}/**/*", "sharedGlobals"],
     "production": [
       "default",
       "!{projectRoot}/**/?(*.)+(spec|test).[jt]s?(x)?(.snap)",
@@ -15,9 +12,7 @@
       "!{projectRoot}/jest.config.[jt]s",
       "!{projectRoot}/test-setup.[jt]s"
     ],
-    "sharedGlobals": [
-      "{workspaceRoot}/.github/workflows/ci.yml"
-    ]
+    "sharedGlobals": ["{workspaceRoot}/.github/workflows/ci.yml"]
   },
   "nxCloudId": "67f4ed637b16f351e65d5530",
   "plugins": [
@@ -60,9 +55,7 @@
       "options": {
         "targetName": "test"
       },
-      "exclude": [
-        "packages/app-0-e2e/**/*"
-      ]
+      "exclude": ["packages/app-0-e2e/**/*"]
     },
     {
       "plugin": "@nx/rollup/plugin",
@@ -85,29 +78,17 @@
   ],
   "targetDefaults": {
     "test": {
-      "dependsOn": [
-        "^build"
-      ]
+      "dependsOn": ["^build"]
     },
     "@nx/esbuild:esbuild": {
       "cache": true,
-      "dependsOn": [
-        "^build"
-      ],
-      "inputs": [
-        "production",
-        "^production"
-      ]
+      "dependsOn": ["^build"],
+      "inputs": ["production", "^production"]
     },
     "@nx/js:swc": {
       "cache": true,
-      "dependsOn": [
-        "^build"
-      ],
-      "inputs": [
-        "production",
-        "^production"
-      ]
+      "dependsOn": ["^build"],
+      "inputs": ["production", "^production"]
     }
   }
 }