visigraph 0.0.3 → 0.0.6

package/README.md

@@ -3,7 +3,9 @@
 Command line for [VisiGraph](https://github.com/textologylabs/visigraph):
 architecture models you can play through.
 
-Early, pre-1.0. Today it validates a model; the journey player follows.
+Early, pre-1.0. Today it validates a model. Next it builds a static,
+playable site from one: no server, works as a file, a GitLab Pages site or
+a Confluence embed.
 
 ```sh
 npm install -g visigraph
@@ -18,3 +20,29 @@ reference, with a path to each one:
 ```
 error: model.yaml:journeys[0].steps[2].endpoint: container 'auth-service' has no endpoint 'token'
 ```
+
+## Self-update
+
+On an interactive launch the CLI checks the npm registry for a newer
+version and offers to update. Saying yes installs the new version and
+re-runs the command you typed on it. Nothing is ever installed without
+that answer.
+
+- Skipped entirely in CI, pipes and non-terminal shells.
+- The network check uses the registry npm is configured with (so a
+  corporate mirror works), is cached for 24 hours, and gives up silently
+  after two seconds. A failed check never blocks or errors the command.
+- Under `npx`, it only prints the newer version and suggests
+  `npx visigraph@latest`.
+- `--version` and `--help` never check.
+
+Disable it:
+
+- per shell or container image: `VISIGRAPH_NO_UPDATE_CHECK=1`
+- centrally, for locked-down or air-gapped environments, in
+  `~/.visigraph/config.yaml`:
+
+  ```yaml
+  update:
+    check: false
+  ```