@bridgething/updater 0.11.0 → 0.12.0

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.
Files changed (2) hide show
  1. package/README.md +20 -34
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -1,49 +1,35 @@
1
1
  # @bridgething/updater
2
2
 
3
- CLI that brings a [bridgething](https://github.com/JoeyEamigh/bridgething) Spotify
4
- Car Thing to a release on a channel.
5
-
6
- It updates the **device** (daemon binary and/or full image), not a webapp. To
7
- install or share a webapp, use [`@bridgething/client`](https://www.npmjs.com/package/@bridgething/client)
8
- and the `push`/`share` scripts a [`create-bridgething`](https://www.npmjs.com/package/create-bridgething)
9
- project ships.
3
+ Bring a [bridgething](https://github.com/JoeyEamigh/bridgething) Spotify Car
4
+ Thing to the latest release on its channel.
10
5
 
11
6
  ```sh
12
7
  bunx @bridgething/updater
13
8
  ```
14
9
 
15
- Connects to a Car Thing over the daemon's network gateway (the USB-gadget link by
16
- default), reads the discover manifest, resolves the target channel's `latest`
17
- composite version, and applies it. If the image half of the version changed it
18
- pushes a full image OTA, otherwise it pushes just the daemon binary, preferring a
19
- published delta over a full artifact. A release that is yanked or deprecated is
20
- refused.
10
+ The updater connects over the daemon's network gateway, reads the release
11
+ manifest, and installs the daemon binary, plus the system image when the image
12
+ half of the version changed. It refuses a yanked or deprecated release.
21
13
 
22
- | Flag | Default | Meaning |
23
- | --- | --- | --- |
24
- | `--root <url>` | `https://ota.bridgething.com` | Manifest + artifact root. |
25
- | `--channel <name>` | the channel the device reports | Channel to track. |
26
- | `--host <ws-url>` | `ws://bridgething.local:8892/` | Daemon network gateway. |
27
- | `--cache-dir <path>` | a directory under the OS tmpdir | Artifact download cache. |
28
- | `--version <ver>` | the channel's `latest` | Composite version to install. |
14
+ | flag | default | meaning |
15
+ | -------------------- | ------------------------------- | ---------------------------- |
16
+ | `--root <url>` | `https://ota.bridgething.com` | Manifest and artifact root |
17
+ | `--channel <name>` | the channel the device reports | Channel to track |
18
+ | `--host <ws-url>` | `ws://bridgething.local:8892/` | Daemon network gateway |
19
+ | `--cache-dir <path>` | a directory under the OS tmpdir | Artifact download cache |
20
+ | `--version <ver>` | the channel's `latest` | Composite version to install |
29
21
 
30
- Multiple devices on the network resolve to distinct mDNS names; point `--host` at
31
- the one you mean:
22
+ The network gateway has no authentication. Run the updater over the USB link or
23
+ a trusted LAN. With several devices, point `--host` at one:
32
24
 
33
25
  ```sh
34
26
  bunx @bridgething/updater --host ws://bridgething-<serial>.local:8892/
35
27
  ```
36
28
 
37
- ## What it is built on
38
-
39
- Everything below the flags - the wire protocol, transfer pacing, delta selection,
40
- artifact downloads, and the OTA state machine - runs in the Rust delivery core,
41
- reached through [`@bridgething/core-node`](https://www.npmjs.com/package/@bridgething/core-node).
42
- Drive updates from your own program by using that package directly. For the same
43
- thing in a browser, use [`@bridgething/browser`](https://www.npmjs.com/package/@bridgething/browser).
44
-
45
- ## Posture
29
+ The same update logic is available from Node through
30
+ [`@bridgething/core-node`](https://www.npmjs.com/package/@bridgething/core-node)
31
+ and from a web page through
32
+ [`@bridgething/browser`](https://www.npmjs.com/package/@bridgething/browser).
46
33
 
47
- The network gateway has no auth, matching the project posture. Treat the update
48
- path like a debug interface: run it over the USB-CDC-ECM gadget link or a trusted
49
- LAN, not an exposed one.
34
+ - Docs: <https://bridgething.com/docs>
35
+ - Source: <https://github.com/JoeyEamigh/bridgething>
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@bridgething/updater",
3
- "version": "0.11.0",
4
- "description": "Update a Spotify Car Thing from the command line, over its network gateway.",
3
+ "version": "0.12.0",
4
+ "description": "Command-line updater that brings a bridgething Spotify Car Thing to a release on a channel.",
5
5
  "license": "MIT",
6
6
  "author": "Joey Eamigh <55670930+JoeyEamigh@users.noreply.github.com> (https://github.com/JoeyEamigh)",
7
7
  "homepage": "https://bridgething.com",
@@ -31,8 +31,8 @@
31
31
  "lint": "eslint ."
32
32
  },
33
33
  "dependencies": {
34
- "@bridgething/core-node": "0.11.0",
35
- "@bridgething/lib": "0.11.0"
34
+ "@bridgething/core-node": "0.12.0",
35
+ "@bridgething/lib": "0.12.0"
36
36
  },
37
37
  "peerDependencies": {
38
38
  "typescript": "^6.0.3"