Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions BRAND_ASSETS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,16 @@

No logo or trademark license is granted by the code license. CompleteTech LLC
names identify the publisher; obtain separate permission for other brand uses.

## Repository artwork

`docs/images/banner.png` and `docs/images/social-preview.png` contain current
CompleteTech LLC project artwork and the embedded CompleteTech LLC logo.
Their editable counterparts are `banner.svg` and `social-preview.svg` in the
same directory. These images remain brand assets under the terms above.

`overview-light.png` and `overview-dark.png` illustrate the documented offline
workflow. They are explanatory diagrams, not screenshots of a live assessment.

The repository artwork does not add branding controls to the executable.
Consult the README for the checker or tool's supported report options.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
<p align="center">
<img src="docs/images/banner.png" alt="scan-results-bridge by CompleteTech LLC" width="100%">
</p>

<p align="center">
<a href="https://github.com/CompleTetech-Security/scan-results-bridge/actions"><img src="https://img.shields.io/github/actions/workflow/status/CompleTetech-Security/scan-results-bridge/tests.yml?label=tests" alt="Tests"></a>
<img src="https://img.shields.io/badge/python-3.10%2B-1E3A8A" alt="Python 3.10+">
<img src="https://img.shields.io/badge/dependencies-none-067647" alt="No runtime dependencies">
<a href="LICENSING.md"><img src="https://img.shields.io/badge/license-AGPL--3.0%20%7C%20commercial-64748B" alt="AGPL-3.0 or commercial license"></a>
</p>

# scan-results-bridge

Optional offline report conversion for the CompleteTech security checker family.
Expand All @@ -20,6 +31,15 @@ before an atomic file publication. Interruptions exit 130 without publication
retry; interrupted stdout or an interrupt at the commit boundary may leave an
incomplete/indeterminate publication. Keep unrelated reports out of commits.

## Offline workflow

<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/images/overview-dark.png">
<img src="docs/images/overview-light.png" alt="Scan Results Bridge offline workflow" width="100%">
</picture>

Supplied local evidence only. The tool does not contact targets or execute the software being assessed.

## Accepted contracts

Select the schema explicitly; one profile applies to all inputs in an invocation.
Expand Down
Binary file added docs/images/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/images/banner.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/overview-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/overview-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/social-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/images/social-preview.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading