Standardize install docs on GitHub tarball distribution

This commit is contained in:
thePR0M3TH3AN committed 2026-02-14 12:29:41 -05:00
1 parent 8ba1966e37
commit 9bf04a3a5b
3 files changed
+33 -9

No files matched your search

+8 -7
View File
@@ -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`
@@ -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.
+2 -2
View File
@@ -535,9 +535,9 @@
</section>
<div class="install-container">
<p class="install-label">Install via NPM</p>
<p class="install-label">Install from GitHub tarball</p>
<div class="install-code-wrapper">
<code id="install-cmd">npm install git+https://github.com/PR0M3TH3AN/TORCH.git</code>
<code id="install-cmd">npm install https://github.com/PR0M3TH3AN/TORCH/archive/refs/heads/main.tar.gz</code>
<button class="copy-install-btn" onclick="copyToClipboard('install-cmd', this, true)">
<svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
<rect x="9" y="9" width="13" height="13" rx="2" ry="2"></rect>