From 9bf04a3a5b63a688bc2b20c3037211f58af06d4d Mon Sep 17 00:00:00 2001 From: thePR0M3TH3AN <53631862+PR0M3TH3AN@users.noreply.github.com> Date: Sat, 14 Feb 2026 12:29:41 -0500 Subject: [PATCH] Standardize install docs on GitHub tarball distribution --- README.md | 15 ++++++------ ...-02-14-distribution-path-github-tarball.md | 23 +++++++++++++++++++ landing/index.html | 4 ++-- 3 files changed, 33 insertions(+), 9 deletions(-) create mode 100644 docs/agent-handoffs/learnings/2026-02-14-distribution-path-github-tarball.md diff --git a/README.md b/README.md index eb9a7f8..eb08246 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,11 @@ TORCH is a portable Nostr-based task locking toolkit for multi-agent coordinatio ## Installation ```bash -npm install git+https://github.com/PR0M3TH3AN/TORCH.git +npm install https://github.com/PR0M3TH3AN/TORCH/archive/refs/heads/main.tar.gz ``` +> TORCH is distributed from GitHub tarballs and is not currently published to the npm registry. + ## Usage ### CLI @@ -16,16 +18,16 @@ The `torch-lock` CLI allows you to check, lock, and list tasks. ```bash # Check locks for a specific cadence -npx torch-lock check --cadence daily +npx --no-install torch-lock check --cadence daily # Lock a task for an agent -AGENT_PLATFORM=codex npx torch-lock lock --agent docs-agent --cadence daily +AGENT_PLATFORM=codex npx --no-install torch-lock lock --agent docs-agent --cadence daily # List all active locks -npx torch-lock list +npx --no-install torch-lock list # Run the Dashboard -npx torch-lock dashboard +npx --no-install torch-lock dashboard ``` ### Configuration (`torch-config.json`) @@ -49,7 +51,7 @@ Configuration options: The dashboard provides a live view of lock events. ```bash -npx torch-lock dashboard --port 4173 +npx --no-install torch-lock dashboard --port 4173 # Open http://localhost:4173/dashboard/ ``` @@ -93,4 +95,3 @@ If you are developing `torch-lock` itself: - `npm run dashboard:serve` - diff --git a/docs/agent-handoffs/learnings/2026-02-14-distribution-path-github-tarball.md b/docs/agent-handoffs/learnings/2026-02-14-distribution-path-github-tarball.md new file mode 100644 index 0000000..4a33b0d --- /dev/null +++ b/docs/agent-handoffs/learnings/2026-02-14-distribution-path-github-tarball.md @@ -0,0 +1,23 @@ +# Single Distribution Path: GitHub Tarball + +## Context +- Installation docs previously mixed npm-style wording with GitHub source installs. +- This caused confusion because the package is not published to the npm registry. + +## Observation +- `README.md` and `landing/index.html` are the two primary user-facing install surfaces. +- Any npm-registry wording in either location risks reintroducing broken install expectations. + +## Action taken +- Standardized both surfaces to one install path: + - `npm install https://github.com/PR0M3TH3AN/TORCH/archive/refs/heads/main.tar.gz` +- Added explicit README guidance that TORCH is distributed via GitHub tarballs and is not on npm registry. +- Updated CLI examples to `npx --no-install` so examples only use locally installed binaries. + +## Validation performed +- Searched docs/UI sources for install phrasing and npm-registry implications. +- Verified updated install command appears consistently in README and landing page. + +## Recommendation for next agents +- Treat GitHub tarball install as the canonical distribution path unless a real npm publish workflow is added. +- If distribution changes in the future, update `README.md`, `landing/index.html`, and this learning note in the same PR. diff --git a/landing/index.html b/landing/index.html index 00bb83e..81a36e0 100644 --- a/landing/index.html +++ b/landing/index.html @@ -535,9 +535,9 @@
Install via NPM
+Install from GitHub tarball
npm install git+https://github.com/PR0M3TH3AN/TORCH.git
+ npm install https://github.com/PR0M3TH3AN/TORCH/archive/refs/heads/main.tar.gz