@rom-weaver/cli 0.7.2 → 0.9.0

package/{LICENSE.md → LICENSE}

@@ -1,3 +1,10 @@
+rom-weaver
+
+SPDX-License-Identifier: AGPL-3.0-or-later
+
+This file contains the GNU Affero General Public License that applies to
+rom-weaver's public distribution.
+
 # GNU AFFERO GENERAL PUBLIC LICENSE
 
 Version 3, 19 November 2007

package/README.md

@@ -7,25 +7,27 @@
 <p align="center">
   <a href="https://www.npmjs.com/package/rom-weaver"><img alt="npm version" src="https://img.shields.io/npm/v/rom-weaver?logo=npm&amp;logoColor=white&amp;label=npm&amp;color=d9690f"></a>
   <a href="https://crates.io/crates/rom-weaver-cli"><img alt="crates.io version" src="https://img.shields.io/crates/v/rom-weaver-cli?logo=rust&amp;logoColor=white&amp;label=crates.io&amp;color=d9690f"></a>
-  <a href="https://github.com/brandonocasey/rom-weaver/pkgs/container/rom-weaver-cli"><img alt="Container images on GitHub Container Registry" src="https://img.shields.io/badge/ghcr.io-rom--weaver-d9690f?logo=docker&amp;logoColor=white"></a>
-  <a href="https://github.com/brandonocasey/homebrew-tap"><img alt="Homebrew tap" src="https://img.shields.io/badge/homebrew-brandonocasey%2Ftap-d9690f?logo=homebrew&amp;logoColor=white"></a>
+  <a href="https://github.com/users/brandonocasey/packages/container/package/rom-weaver-cli"><img alt="Container images on GitHub Container Registry" src="https://img.shields.io/badge/ghcr.io-rom--weaver-d9690f?logo=docker&amp;logoColor=white"></a>
+  <a href="https://github.com/rom-weaver/homebrew-tap"><img alt="Homebrew tap" src="https://img.shields.io/badge/homebrew-rom--weaver%2Ftap-d9690f?logo=homebrew&amp;logoColor=white"></a>
 </p>
 
 <p align="center">
-  <a href="https://github.com/brandonocasey/rom-weaver/actions/workflows/ci.yml"><img alt="CI status" src="https://img.shields.io/github/actions/workflow/status/brandonocasey/rom-weaver/ci.yml?branch=main&amp;logo=githubactions&amp;logoColor=white&amp;label=CI&amp;color=4a6d63"></a>
+  <a href="https://github.com/rom-weaver/rom-weaver/actions/workflows/ci.yml"><img alt="CI status" src="https://img.shields.io/github/actions/workflow/status/rom-weaver/rom-weaver/ci.yml?branch=main&amp;logo=githubactions&amp;logoColor=white&amp;label=CI&amp;color=4a6d63"></a>
   <a href="package.json"><img alt="Node.js 22 or newer" src="https://img.shields.io/badge/Node.js-22%2B-4a6d63?logo=nodedotjs&logoColor=white"></a>
-  <a href=".mise.toml"><img alt="Rust 1.95" src="https://img.shields.io/badge/Rust-1.95-2c323b?logo=rust&logoColor=white"></a>
-  <a href="LICENSE.md"><img alt="AGPL-3.0-or-later license" src="https://img.shields.io/badge/license-AGPL--3.0--or--later-4a6d63"></a>
+  <a href=".config/mise.toml"><img alt="Rust 1.95" src="https://img.shields.io/badge/Rust-1.95-2c323b?logo=rust&logoColor=white"></a>
+  <a href="LICENSE"><img alt="AGPL-3.0-or-later license" src="https://img.shields.io/badge/license-AGPL--3.0--or--later-4a6d63"></a>
 </p>
 
 <p align="center">
-  <a href="https://rom-weaver.com/">Open the webapp</a>
+  <a href="https://rom-weaver.com/weave">Open the webapp</a>
   · <a href="docs/README.md">Docs index</a>
+  · <a href="https://github.com/sponsors/brandonocasey">Sponsor on GitHub</a>
   · <a href="https://ko-fi.com/brandonocasey">Support on Ko-fi</a>
 </p>
 
 <!-- START doctoc -->
 
+- [Why](#why)
 - [Features](#features)
 - [Notices](#notices)
 - [Install](#install)
@@ -36,12 +38,40 @@
 
 <!-- END doctoc -->
 
+## Why
+
+Every console generation brought its own compressed format, and each one came
+with its own tool. CHD for discs, RVZ for GameCube and Wii, Z3DS for 3DS, CSO
+and PBP for PSP, plus the usual ZIP and 7z on top. Those tools are scattered
+across projects, most are command-line only, and plenty of them only ship
+builds for one or two platforms. If you are on a Mac, or on Windows without a
+compiler handy, half of them are out of reach. Anyone who has tried to shrink a
+disc collection knows the routine: track down five programs, learn five sets of
+flags, and hope each one still builds.
+
+Patching has the same problem from a different angle. Most patchers take one
+patch at a time, so a translation plus a bugfix plus an undub means running the
+tool three times and keeping the intermediate files straight yourself. And
+because almost no patcher reads compressed input, the real sequence is
+decompress, patch, recompress - every time you want to try a different patch or
+redo one you already applied. That is a lot of disk churn and waiting for what
+should be a single step.
+
+The last piece is curation. Keeping a collection in order means storing ROMs
+compressed, keeping the patches next to them, and being able to prove months
+later that a patched file came from the ROM you think it did. rom-weaver
+handles all of it in one place: read and write every format above, chain as
+many patches as you want in a single pass without unpacking to disk first, and
+record the whole recipe - patch order, checksums, output names - in a bundle
+file you can hand to someone else. It runs the same on Linux, macOS, and
+Windows, and in the browser if you would rather not install anything.
+
 ## Features
 
-- **Apply and create patches.** IPS, BPS, UPS, xdelta/VCDIFF, PPF, RUP,
-  BDF/BSDIFF40, APS, DCP (Dreamcast), and more than twenty formats in total,
-  with ordered multi-patch chains, strict checksum validation, and cheat-code
-  baking. A few - DCP, BSP, and HDiffPatch among them - are apply-only.
+- **Apply and create patches.** Twenty-one formats, including IPS, BPS, UPS,
+  xdelta/VCDIFF, PPF, RUP, BDF/BSDIFF40, APS, and DCP (Dreamcast), with ordered
+  multi-patch chains, strict checksum validation, and cheat-code baking. Three
+  of them (DCP, BSP, and HDiffPatch) can only be applied, not created.
 - **Inspect and extract containers.** ZIP, 7z, RAR, the tar family, CHD, RVZ,
   Z3DS, CSO, PBP, GCZ, WIA, WBFS, and more, including nested archives.
 - **Create compressed containers.** ZIP, 7z, CHD, RVZ, and Z3DS with
@@ -78,9 +108,9 @@ rely on the APIs or CLI flags, expect things to be a bit tougher: those
 interfaces may still change as the project heads toward v1.0. Trim and Tools are
 currently untested but theoretically working, so they are disabled in the
 current webapp. The `rom-weaver-core`, `-checksum`, `-containers`, and
-`-patches` crates are published to crates.io only so `rom-weaver-cli` can be;
-the CLI and the webapp are the supported interfaces, and using those crates as
-libraries elsewhere is not supported.
+`-patches` crates are published to crates.io only so `rom-weaver-cli` can use
+them. The CLI and the webapp are the supported interfaces; using those crates as
+libraries in another project is not supported.
 
 ### First public release
 
@@ -101,17 +131,23 @@ debugging, and review. I make the engineering decisions and review and test
 the resulting work myself; the goal is high-quality, dependable software, but
 AI-assisted code may still need extra scrutiny.
 
+### Translations
+
+Localized translations are early and may be entirely wrong in places. Manual
+edits and corrections are welcome.
+
 ## Install
 
 ### Webapp
 
-Open the hosted webapp at **[rom-weaver.com](https://rom-weaver.com/)**. There
-is nothing to install and no account: choose **Weave**, add a ROM and one or
-more patches, review the detected formats and checksums, then run the workflow
-and save the result. Use **Create** to generate a distributable patch from
-an original and a modified file. Your files are processed locally and never
-leave the device. Install it as a PWA from the browser menu to use it offline.
-New here? [Try the sample weave](https://rom-weaver.com/?bundle=first-weave.zip#/weave)
+Open the hosted webapp at **[rom-weaver.com/weave](https://rom-weaver.com/weave)**. You
+do not need to install anything or create an account. Choose **Weave**, add a
+ROM and one or more patches, review the detected formats and checksums, then run
+the workflow and save the result. Use **Create** to generate a distributable
+patch from an original and a modified file. Your files are processed locally
+and never leave the device. Install it as a PWA from the browser menu to use it
+offline.
+New here? [Try the sample weave](https://rom-weaver.com/weave?bundle=first-weave.zip)
 with tiny synthetic files.
 
 <a name="self-host-the-webapp"></a>
@@ -119,8 +155,9 @@ with tiny synthetic files.
 <details>
 <summary>Self-host the webapp</summary>
 
-The Docker source build serves the full webapp — WASM build, cross-origin
-isolation headers, SPA fallback, and precompressed assets included. The
+The Docker source build serves the full webapp: it builds the WASM module, adds
+cross-origin isolation headers, supports client-side routes, and precompresses
+assets. The
 [self-hosting guide](docs/self-hosting.md) covers reverse proxies, subpath
 routing, HTTPS certificates, service-worker scope, and the required COOP/COEP
 headers.
@@ -128,7 +165,7 @@ headers.
 Build and start it with Docker Compose:
 
 ```bash
-git clone https://github.com/brandonocasey/rom-weaver.git
+git clone https://github.com/rom-weaver/rom-weaver.git
 cd rom-weaver
 docker compose up --build --detach
 curl --fail --silent --show-error http://localhost:8080/health
@@ -152,7 +189,7 @@ arm64, and i686 musl; and Windows arm64, x86-64, and x86.
 <summary>Homebrew (macOS arm64/Intel, Linux arm64/x86-64)</summary>
 
 ```bash
-brew install brandonocasey/tap/rom-weaver
+brew install rom-weaver/tap/rom-weaver
 ```
 
 </details>
@@ -161,7 +198,7 @@ brew install brandonocasey/tap/rom-weaver
 <summary>Scoop (Windows)</summary>
 
 ```powershell
-scoop bucket add brandonocasey https://github.com/brandonocasey/scoop-bucket
+scoop bucket add rom-weaver https://github.com/rom-weaver/scoop-bucket
 scoop install rom-weaver
 ```
 
@@ -175,7 +212,7 @@ Override with `ROM_WEAVER_INSTALL_DIR` or pin with `ROM_WEAVER_VERSION`.
 
 ```bash
 curl --proto '=https' --tlsv1.2 -LsSf \
-  https://raw.githubusercontent.com/brandonocasey/rom-weaver/main/install.sh | sh
+  https://raw.githubusercontent.com/rom-weaver/rom-weaver/main/install.sh | sh
 ```
 
 </details>
@@ -186,7 +223,7 @@ curl --proto '=https' --tlsv1.2 -LsSf \
 The same thing for PowerShell, installing to `%LOCALAPPDATA%\rom-weaver\bin`.
 
 ```powershell
-irm https://raw.githubusercontent.com/brandonocasey/rom-weaver/main/install.ps1 | iex
+irm https://raw.githubusercontent.com/rom-weaver/rom-weaver/main/install.ps1 | iex
 ```
 
 </details>
@@ -228,13 +265,14 @@ cargo binstall rom-weaver-cli
 <details>
 <summary>mise</summary>
 
-Useful when you want the CLI managed per project in `mise.toml`. mise verifies
+Useful when you want the CLI managed per project in `mise.toml`.
+[Install mise](https://mise.jdx.dev/installing-mise.html) first; it verifies
 the release's GitHub artifact attestations on install. The
 `minimum_release_age=0s` option lets new releases resolve immediately on release
 day; omit it if you prefer mise's default release-age delay.
 
 ```bash
-mise use 'github:brandonocasey/rom-weaver[minimum_release_age=0s]'
+mise use 'github:rom-weaver/rom-weaver[minimum_release_age=0s]'
 ```
 
 </details>
@@ -265,7 +303,7 @@ See [Run in Docker](docs/cli.md#run-in-docker).
 <summary>Build from source</summary>
 
 ```bash
-git clone https://github.com/brandonocasey/rom-weaver.git
+git clone https://github.com/rom-weaver/rom-weaver.git
 cd rom-weaver
 cargo install --path crates/rom-weaver-cli --locked
 rom-weaver --help
@@ -295,7 +333,7 @@ webapp builds, and tests.
   </thead>
   <tbody>
     <tr>
-      <td>Desktop — Apply patches (Weave)</td>
+      <td>Desktop: Apply patches (Weave)</td>
       <td>
         <picture>
           <source media="(prefers-color-scheme: dark)" srcset="packages/rom-weaver-webapp/design/weave-desktop-dark.png">
@@ -304,7 +342,7 @@ webapp builds, and tests.
       </td>
     </tr>
     <tr>
-      <td>Desktop — Create a patch</td>
+      <td>Desktop: Create a patch</td>
       <td>
         <picture>
           <source media="(prefers-color-scheme: dark)" srcset="packages/rom-weaver-webapp/design/create-desktop-dark.png">
@@ -313,7 +351,7 @@ webapp builds, and tests.
       </td>
     </tr>
     <tr>
-      <td>Mobile — Apply patches (Weave)</td>
+      <td>Mobile: Apply patches (Weave)</td>
       <td align="center">
         <picture>
           <source media="(prefers-color-scheme: dark)" srcset="packages/rom-weaver-webapp/design/weave-mobile-dark.png">
@@ -322,7 +360,7 @@ webapp builds, and tests.
       </td>
     </tr>
     <tr>
-      <td>Mobile — Create a patch</td>
+      <td>Mobile: Create a patch</td>
       <td align="center">
         <picture>
           <source media="(prefers-color-scheme: dark)" srcset="packages/rom-weaver-webapp/design/create-mobile-dark.png">
@@ -341,18 +379,27 @@ integration, development, architecture, and format-reference guides.
 ## Contributing and support
 
 Bug reports and contributions are welcome. Read the
-[contribution guide](.github/CONTRIBUTING.md) and [code of conduct](.github/CODE_OF_CONDUCT.md)
-before submitting a change, and report
+[contribution guide](CONTRIBUTING.md) and [code of conduct](.github/CODE_OF_CONDUCT.md)
+before submitting a change. Because rom-weaver is dual-licensed, code and
+documentation changes need a one-time signature on the
+[Contributor License Agreement](CLA.md) - the `CLA Signed` check asks for
+it on your first pull request, it covers every repository in the
+[`rom-weaver` organization](https://github.com/rom-weaver), and you keep the
+copyright in your work. Report
 suspected vulnerabilities through GitHub's private reporting form in the
 [security policy](.github/SECURITY.md). If rom-weaver has been useful to you, you can
-support continued development on [Ko-fi](https://ko-fi.com/brandonocasey).
+support continued development through
+[GitHub Sponsors](https://github.com/sponsors/brandonocasey) or
+[Ko-fi](https://ko-fi.com/brandonocasey).
 
 ## License
 
-Copyright (C) Brandon Casey
+Copyright (C) Brandon Casey and rom-weaver contributors
 
-See [LICENSE.md](LICENSE.md) for the license terms. Bundled third-party
-components retain their own licenses. Release builds include a generated
-[attribution notice](https://rom-weaver.com/NOTICE),
-[third-party license inventory](https://rom-weaver.com/THIRD_PARTY_LICENSES.md),
-and corresponding license texts.
+The public distribution is licensed under
+[AGPL-3.0-or-later](LICENSE). [Commercial licensing](COMMERCIAL_LICENSE.md) is
+also available for first-party rom-weaver code. Bundled third-party components
+retain their own licenses. Release builds include a generated
+[attribution and license inventory](https://rom-weaver.com/NOTICE) and
+corresponding license texts. Those third-party terms continue to apply under
+every rom-weaver licensing option.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rom-weaver/cli",
-  "version": "0.7.2",
+  "version": "0.9.0",
   "author": "Brandon Casey",
   "license": "AGPL-3.0-or-later",
   "description": "Local-first toolkit for ROMs and disc images: inspect, extract, compress, and apply, create, or bundle patches. Offline via a browser service-worker PWA or CLI.",
@@ -17,10 +17,13 @@
     "cli"
   ],
   "homepage": "https://rom-weaver.com",
-  "funding": "https://ko-fi.com/brandonocasey",
+  "funding": [
+    "https://github.com/sponsors/brandonocasey",
+    "https://ko-fi.com/brandonocasey"
+  ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/brandonocasey/rom-weaver.git"
+    "url": "https://github.com/rom-weaver/rom-weaver.git"
   },
   "type": "module",
   "bin": {
@@ -50,7 +53,7 @@
   "files": [
     "bin/rom-weaver.mjs",
     "docs/man/*.1",
-    "LICENSE.md"
+    "LICENSE"
   ],
   "publishConfig": {
     "access": "public",
@@ -60,21 +63,21 @@
     "node": ">=22"
   },
   "optionalDependencies": {
-    "@rom-weaver/darwin-arm64": "0.7.2",
-    "@rom-weaver/darwin-x64": "0.7.2",
-    "@rom-weaver/linux-arm64-musl": "0.7.2",
-    "@rom-weaver/linux-ia32-musl": "0.7.2",
-    "@rom-weaver/linux-x64-gnu": "0.7.2",
-    "@rom-weaver/linux-x64-musl": "0.7.2",
-    "@rom-weaver/win32-arm64-msvc": "0.7.2",
-    "@rom-weaver/win32-ia32-msvc": "0.7.2",
-    "@rom-weaver/win32-x64-msvc": "0.7.2"
+    "@rom-weaver/darwin-arm64": "0.9.0",
+    "@rom-weaver/darwin-x64": "0.9.0",
+    "@rom-weaver/linux-arm64-musl": "0.9.0",
+    "@rom-weaver/linux-ia32-musl": "0.9.0",
+    "@rom-weaver/linux-x64-gnu": "0.9.0",
+    "@rom-weaver/linux-x64-musl": "0.9.0",
+    "@rom-weaver/win32-arm64-msvc": "0.9.0",
+    "@rom-weaver/win32-ia32-msvc": "0.9.0",
+    "@rom-weaver/win32-x64-msvc": "0.9.0"
   },
   "scripts": {
-    "docs:toc": "bash scripts/update-markdown-toc.sh",
+    "docs:toc": "node scripts/update-markdown-toc.mjs",
     "dev": "mise run dev",
     "preview": "mise run preview",
-    "hooks:install": "lefthook install",
+    "hooks:install": "node scripts/lefthook-install.mjs",
     "hooks:run": "lefthook run pre-commit --force",
     "hooks:validate": "lefthook validate",
     "prepack": "mise run manpages",