routstrd 0.4.9 → 0.4.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -26,7 +26,29 @@ npm or running from source requires the [Bun](https://bun.sh) runtime.
26
26
 
27
27
  ### Step 1: Install
28
28
 
29
- **Standalone binary:**
29
+ **Standalone binary (recommended):**
30
+
31
+ Installs the standalone executable for Linux or macOS (x64 or arm64) into
32
+ `$HOME/.local/bin`. No Bun, Node.js, or npm required.
33
+
34
+ ```sh
35
+ curl -fsSL https://github.com/Routstr/routstrd/releases/latest/download/install.sh | sh
36
+ ```
37
+
38
+ Pin a version, change the install directory, or print the resolved asset without
39
+ installing anything:
40
+
41
+ ```sh
42
+ curl -fsSL https://github.com/Routstr/routstrd/releases/latest/download/install.sh \
43
+ | sh -s -- --version 0.4.9 --dir /usr/local/bin
44
+ ```
45
+
46
+ The installer downloads the release archive, verifies it against the release
47
+ `SHA256SUMS`, and only replaces an existing `routstrd` once the checksum matches
48
+ and the extracted binary reports the expected version.
49
+
50
+ <details>
51
+ <summary>Manual install</summary>
30
52
 
31
53
  Download the archive for your operating system and architecture from the
32
54
  [latest GitHub Release](https://github.com/Routstr/routstrd/releases/latest).
@@ -42,6 +64,12 @@ install -m 755 routstrd "$HOME/.local/bin/routstrd"
42
64
  Substitute the version, platform, and architecture for the archive you
43
65
  downloaded, and ensure `$HOME/.local/bin` is on `PATH`.
44
66
 
67
+ </details>
68
+
69
+ Installing the standalone binary is preferred over the npm package: the npm
70
+ package runs through the Bun runtime, while the standalone executable has no
71
+ runtime dependency.
72
+
45
73
  **Global with bun:**
46
74
  ```sh
47
75
  bun i -g routstrd
@@ -310,10 +338,11 @@ not part of `bun test`.
310
338
  1. Set a new `package.json` version and commit it. The release tag must be the
311
339
  same version prefixed with `v`, and the tag must not already exist.
312
340
  2. Push the tag. The release workflow runs lint and tests, builds Linux and
313
- macOS executables for x64 and arm64, smoke-tests them, and publishes the
314
- archives with `SHA256SUMS`.
315
- 3. Verify all four archives appear in the GitHub Release and validate each
316
- checksum before announcing it.
341
+ macOS executables for x64 and arm64, smoke-tests them, verifies the archives
342
+ through `install.sh` itself, and publishes the archives with `SHA256SUMS` and
343
+ `install.sh`.
344
+ 3. Verify all four archives and `install.sh` appear in the GitHub Release and
345
+ validate each checksum before announcing it.
317
346
  4. In disposable environments for each platform, test `--version`, `--help`,
318
347
  foreground startup failure, and background `start`, `status`, and `stop`
319
348
  without Bun on `PATH`.