Rebase

.vscode/launch.json

@@ -0,0 +1,37 @@
+{
+    "version": "0.2.0",
+    "compounds": [
+      {
+        "name": "Main + renderer",
+        "configurations": ["Main", "Renderer"],
+        "stopAll": true
+      }
+    ],
+    "configurations": [
+      {
+        "name": "Renderer",
+        "port": 9223,
+        "request": "attach",
+        "type": "chrome",
+        "webRoot": "${workspaceFolder}",
+        "timeout": 30000
+      },
+      {
+        "name": "Main",
+        "type": "node",
+        "request": "launch",
+        "cwd": "${workspaceFolder}",
+        "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron",
+        "windows": {
+          "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron.cmd"
+        },
+        "args": [".", "--remote-debugging-port=9223"],
+        "outputCapture": "std",
+        "console": "integratedTerminal",
+        "env": {
+          "AXONOPS_DEV_TOOLS": "true"
+        }
+      }
+    ]
+  }
+

README.md

@@ -1,6 +1,8 @@
-# AxonOps™ Workbench for Apache Cassandra®
+# AxonOps™ Workbench
 
-AxonOps Workbench for Apache Cassandra is a desktop application built for Cassandra DB developers and DBAs. Seamlessly connect and interact with Apache Cassandra clusters while enjoying a host of innovative enhancements and exciting features. 
+[AxonOps Workbench](https://axonops.com/workbench/) is a desktop application built for Cassandra DB developers and DBAs. Kafka support is coming soon! 
+
+Seamlessly connect and interact with Apache Cassandra clusters while enjoying a host of innovative enhancements and exciting features. 
 
 We welcome your feedback, so feel free to discuss any ideas you have https://github.com/axonops/axonops-workbench/discussions/categories/ideas or raise issues any issues (https://github.com/axonops/axonops-workbench/issues/new/choose)
 
@@ -51,6 +53,32 @@ and for the daily internal builds (used for testing and development purposes) us
 brew install --cask axonopsworkbench-internal
 ```
 
+### Software Bill of Materials (SBOM)
+
+This project provides Software Bill of Materials (SBOM) files with each release, offering transparency into our software components and dependencies. SBOMs help users and organizations understand exactly what components are included in our software, enabling better security and compliance management.
+
+**Available SBOM Formats**
+- CycloneDX (sbom.cyclonedx.json): A lightweight SBOM standard that provides detailed component information and security context
+- SPDX (sbom.spdx.json): A comprehensive format focusing on software licensing and component identification
+
+**Benefits of Our SBOM**
+- Security: Easily identify and track known vulnerabilities in dependencies
+- Compliance: Verify license obligations for all included components
+- Transparency: Clear visibility into the software supply chain
+- Risk Management: Better understand and assess potential risks in the software stack
+
+You can find our SBOM files in each [release](releases) as part of the release artifacts. These files are automatically generated during our build process to ensure they remain current with each release.
+
+**Using SBOM Files**
+- Download the SBOM file in your preferred format from the release assets
+- Use SBOM analysis tools like:
+  - `cyclonedx-cli` for CycloneDX files
+  - `spdx-tools` for SPDX files
+- Integrate with your security and compliance workflows
+- Monitor for vulnerabilities in included components
+
+We maintain these SBOM files as part of our commitment to software supply chain security and transparency. They are updated with each release to reflect the current state of our software dependencies.
+
 ## Tidying up between beta release installs
 
 The current builds are still in development and are not necessarily backwards compatible, so do this before taking a new beta release
@@ -74,14 +102,20 @@ If you would like to run it in development, please follow the instructions below
 
 - nodejs >= 20.15.0
 - npm >= 10.7.0
+- python >= 3.12
 
 ### Installation & Running
 
 - Clone this repository
+- Install python dependencies `pip3 install -r requirements.txt`
+- Install required tools by running `./install_tools.sh`. It will download CQLSH binaries from [axonops-workbench-cqlsh](https://github.com/axonops/axonops-workbench-cqlsh/releases/latest).
 - Run `npm i` to install the nodejs dependencies
 - Execute `npm start` to run it in development mode
 
-> **_NOTE:_** You can set the environment variable `AXONOPS_DEV_TOOLS=true` to open the developer tools on start up
+### Debugging
+
+- You can set the environment variable `AXONOPS_DEV_TOOLS=true` to open the developer tools on start up
+- Using VSCode, you can use `Main + Renderer` compound launch configuration to debug main process and rendereres simultaneously
 
 ### Packaging
 
@@ -100,5 +134,5 @@ See the `packages.json` for other build options.
 
 ***
 
-*AxonOps is a registered trademark of AxonOps Limited. Apache, Apache Cassandra, Cassandra, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries.*
+*This project may contain trademarks or logos for projects, products, or services. Any use of third-party trademarks or logos are subject to those third-party's policies. AxonOps is a registered trademark of AxonOps Limited. Apache, Apache Cassandra, Cassandra, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries.*