Skip to content

Commit 61fd6e7

Browse files
committed
Update README.md
Updated README to clarify the limited functionality of Workbench and point readers to ScanCode.io and DejaCode for most use cases. Signed-off-by: Michael Herzog <mjherzog@aboutcode.org>
1 parent 4811dac commit 61fd6e7

1 file changed

Lines changed: 23 additions & 10 deletions

File tree

README.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,32 @@
44
[![Test CI](https://github.com/aboutcode-org/scancode-workbench/actions/workflows/Test.yml/badge.svg)](https://github.com/aboutcode-org/scancode-workbench/actions/workflows/Test.yml)
55
[![Release](https://github.com/aboutcode-org/scancode-workbench/actions/workflows/Release.yml/badge.svg)](https://github.com/aboutcode-org/scancode-workbench/actions/workflows/Release.yml)
66

7-
ScanCode Workbench provides an advanced visual UI to help you quickly evaluate
8-
license and other notices identified by
9-
[ScanCode](https://github.com/aboutcode-org/scancode-toolkit/).
10-
[ScanCode](https://github.com/aboutcode-org/scancode-toolkit/) detects licenses,
11-
copyrights and other interesting information in your code.
12-
13-
ScanCode Workbench is based on [Electron](https://www.electronjs.org/) and will
14-
be the primary desktop/GUI tool for using nexB’s
15-
[AboutCode tools](https://github.com/nexB/aboutcode). This app works on Windows,
16-
macOS and Linux operating systems.
7+
ScanCode Workbench provides a visual UI (GUI) to help you quickly evaluate
8+
license, copyright and other important information from a
9+
[ScanCode Toolkit](https://github.com/aboutcode-org/scancode-toolkit/) scan.
10+
11+
The Workbench is a single-user desktop application that works on Windows,
12+
macOS, and Linux operating systems. There is no current or planned future
13+
functionality to edit or update scan results - the Scan data is read-only.
14+
15+
If you need a multi-user application for running or reviewing ScanCode scans,
16+
you should use [ScanCode.io](https://github.com/aboutcode-org/scancode.io)
17+
instead of ScanCode Workbench. You cannot edit scan data in ScanCode.io, but
18+
you can export the scan data in SBOM, XLSX and other formats for further
19+
analysis and processing. You can also import a ScanCode Toolkit scan into
20+
ScanCode.io using the `load_inventory` pipeline.
21+
22+
If you need an application to review and edit ScanCode scan data or to convert
23+
that data into an SBOM or a software inventory, you should use [DejaCode](https://github.com/aboutcode-org/dejacode). You can import scan data from ScanCode Toolkit or ScanCode.io into DejaCode or you can import an SBOM. The DejaCode
24+
Dashboard provides immediate visibility into license or vulnerability issues
25+
related to your products, components and packages. You can use the [DejaCode demo system](https://public.dejacode.com/account/register/) for quick access to its
26+
features and functions.
1727

1828
![ScanCode Workbench](/src/assets/images/workbench_intro.gif)
1929

30+
ScanCode Workbench is based on [Electron](https://www.electronjs.org/).
31+
32+
2033
## Using
2134

2235
- You can

0 commit comments

Comments
 (0)