From 5dc741878910c1f009d495df01ed0584c67bf777 Mon Sep 17 00:00:00 2001 From: QuickMythril Date: Wed, 15 Jul 2026 23:17:18 -0400 Subject: [PATCH] docs: add publishing, QAVS, and Home-vs-browser notes Document the qdn:publish workflow with its QORTIUM_NODE_* environment overrides and API key fallback chain, note the QAVS 1.4.1 version and qortium-app.json build manifest, and state that settings edits and restarts require Qortium Home while plain-browser use stays read-only. Co-Authored-By: Claude Fable 5 --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index 0fcaba2..58f687c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ A QDN app for inspecting and managing the active Qortium Core node. +Settings edits and node restarts require running inside Qortium Home, which +provides the write bridge actions; in a plain browser the app feature-detects +the missing `window.qdnRequest` bridge and stays read-only. + Default QDN identity: - `APP/Node/Node` @@ -37,6 +41,35 @@ npm test npm run dev ``` +Versioning: + +- Node follows the Qortium app versioning standard (QAVS): the current app + version is 1.4.1, where the `1.4` prefix declares the minimum Qortium + platform level the app is built against and the last number is the app's + own release counter. +- The build emits a `qortium-app.json` manifest (see `vite.config.ts`) that + Qortium Home reads from the published root. + +Publishing: + +```bash +npm run build +npm run qdn:publish +``` + +- By default the publish helper uploads `dist/` as `qdn://APP/Node/Node` + through `http://127.0.0.1:24891`, using the local preview account files + under `~/qortium/git/qortium-core/preview/`. +- The helper uses `QORTIUM_NODE_NODE_API_KEY` or + `QORTIUM_NODE_NODE_API_KEY_PATH` when set, then tries the API key for the + active local Core process, and finally falls back to + `~/.config/qortium-core/runtime/apikey.txt`. +- Set `QORTIUM_NODE_NODE_API_URL`, `QORTIUM_NODE_QDN_NAME`, + `QORTIUM_NODE_QDN_IDENTIFIER`, `QORTIUM_NODE_QDN_TITLE`, + `QORTIUM_NODE_QDN_SERVICE`, `QORTIUM_NODE_DIST_PATH`, or + `QORTIUM_NODE_PREVIEW_ACCOUNTS_PATH` to publish another QDN resource or use + another node. + Editable settings: - Keep `PHASE_1_EDITABLE_SETTING_KEYS` in the same logical order as