Skip to content

Commit e6d6c01

Browse files
Align README license wording with LICENSING.md; tighten details
Address review: AGPL option is not limited to non-commercial use, name the --fail-on-finding triggers, note robots gating and downgrade stop, widen the unknown row, and crop screenshots below the fix table. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
1 parent e5b19a3 commit e6d6c01

4 files changed

Lines changed: 8 additions & 8 deletions

File tree

‎BRAND_ASSETS.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Brand assets
22

33
CompleteTech LLC names, logos, and brand assets included in this repository,
4-
including `assets/logo.png` and the images in `docs/images/`, are not licensed under the AGPL-3.0 or a commercial
5-
code license.
4+
including `assets/logo.png` and the images in `docs/images/`, are not licensed
5+
under the AGPL-3.0 or a commercial code license.
66

77
They remain trademarks, service marks, or brand assets of CompleteTech LLC and
88
may not be reused in a way that suggests endorsement, affiliation, sponsorship,

‎README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ python node2shell_check.py --inventory runtime.json --format html --output repor
3030
python node2shell_check.py --input websites.txt --format html --output websites-report.html
3131
```
3232

33-
Python 3.10+ on Windows, macOS, or Linux. Nothing to install. Node.js is needed only to run the optional collector.
33+
Python 3.10+ on Windows, macOS, or Linux. Nothing to install; use `python3` where `python` is not Python 3. Node.js is needed only to run the optional collector.
3434

3535
## The report
3636

37-
`--format html` produces a single offline, script-free file with your logo, summary tiles, every result with its evidence and next step, and the upstream fix table. It follows the reader's light or dark theme and prints cleanly.
37+
`--format html` produces a single offline, script-free file with a logo, summary tiles, every result with its evidence and next step, and the upstream fix table. It follows the reader's light or dark theme and prints cleanly.
3838

3939
<p align="center">
4040
<picture>
@@ -45,7 +45,7 @@ Python 3.10+ on Windows, macOS, or Linux. Nothing to install. Node.js is needed
4545

4646
<p align="center"><sub>Synthetic example built from reserved <code>example.*</code> domains and invented runtimes. <a href="docs/example-report.html">View the HTML</a>.</sub></p>
4747

48-
Use `--logo path/to/logo.png` and `--brand "Your Company"` to brand it for your own organization. CSV and JSON remain available for spreadsheets and pipelines; `--fail-on-finding` exits 1 when a pipeline should stop.
48+
Use `--logo path/to/logo.png` and `--brand "Your Company"` to brand it for your own organization. CSV and JSON remain available for spreadsheets and pipelines. `--fail-on-finding` exits 1 when any result is `potentially_affected` or `unsupported_runtime`; operational errors exit 2.
4949

5050
## What the results mean
5151

@@ -54,7 +54,7 @@ Use `--logo path/to/logo.png` and `--brand "Your Company"` to brand it for your
5454
| 🔴 `potentially_affected` | A plain Node.js version below its branch's fix is reported. Verify the deployed build and prioritize remediation. |
5555
| 🟠 `unsupported_runtime` | The version is on an older, unsupported upstream line. Verify vendor support and move to a supported, patched runtime. |
5656
| 🟢 `fixed_version_reported` | The reported version meets the fix. Not independent verification of installed patches. |
57-
| ⚪ `unknown` | Version missing, conflicting, qualified, custom-built, pre-release, or outside this rule snapshot. |
57+
| ⚪ `unknown` | Version missing, malformed, conflicting, vendor-qualified, custom-built, pre-release, possibly backported, or outside this rule snapshot. |
5858

5959
| Node.js branch | 22.x | 24.x | 26.x |
6060
| --- | --- | --- | --- |
@@ -69,7 +69,7 @@ Thresholds come from the [Node.js October 2026 security releases](https://nodejs
6969

7070
- **Known version:** `--node-version` (repeatable) compares a version you obtained elsewhere. No network calls.
7171
- **Runtime inventory:** `collect-runtime.cjs` records version and build metadata from the Node.js binary that runs the service. It never loads application code, reads environment variables, decompresses data, or opens a connection, and it cannot attest vendor patch provenance.
72-
- **Website metadata:** reads `robots.txt`, then makes ordinary `GET` requests with verified TLS, an honest User-Agent, bounded responses, and pacing. Redirects stay on the same host or its `www` counterpart. It fetches nothing else and sends no compressed bodies, credentials, or crafted requests.
72+
- **Website metadata:** reads `robots.txt`, then makes an ordinary `GET` request to the page if allowed, with verified TLS, an honest User-Agent, bounded responses, and pacing. Redirects stay on the same host or its `www` counterpart, and HTTPS downgrades stop. It fetches nothing else and sends no compressed bodies, credentials, or crafted requests.
7373

7474
Input modes can be combined in one report; each observation keeps its own evidence. Express or Next.js hints never become Node.js version evidence, and Brotli response compression does not prove request decoding.
7575

@@ -89,7 +89,7 @@ For agents contributing to this repository, [AGENTS.md](AGENTS.md) contains the
8989

9090
## License
9191

92-
Dual licensed. It's free under [AGPL-3.0](LICENSE) for research, education, and open-source use. A commercial license is available for closed-source products and hosted services that don't publish their source; see [LICENSING.md](LICENSING.md) for details. The CompleteTech LLC name and logo are covered by neither license; see [BRAND_ASSETS.md](BRAND_ASSETS.md).
92+
Dual licensed: [AGPL-3.0](LICENSE), including commercial use that meets its terms, or a [commercial license](LICENSING.md#commercial-license) from CompleteTech LLC for closed-source products and services that don't fit the AGPL model. See [LICENSING.md](LICENSING.md) for details. The CompleteTech LLC name and logo are covered by neither license; see [BRAND_ASSETS.md](BRAND_ASSETS.md).
9393

9494
<p align="center">
9595
<a href="https://complete.tech"><img src="assets/logo.png" alt="CompleteTech LLC" width="160"></a><br>

‎docs/images/report-dark.png‎

21.2 KB
Loading

‎docs/images/report-light.png‎

16.1 KB
Loading

0 commit comments

Comments
 (0)