notioncode 0.1.0 → 0.1.2

package/README.md

@@ -1,30 +1,38 @@
-# @nocodenotioncode
+# notioncode
 
-Run the Notion Code local companion without opening the Tauri desktop shell.
+Run the local companion runtime behind the `npx notioncode start` flow.
 
 ## Intended usage
 
 ```bash
-npx @nocodenotioncode start
+npx notioncode start
 ```
 
 Options:
 
 ```bash
-npx @nocodenotioncode install
-npx @nocodenotioncode doctor
-npx @nocodenotioncode start --with-local-ui
+npx notioncode install
+npx notioncode doctor
+npx notioncode start
 ```
 
 ## What it starts
 
 - localhost bridge on `127.0.0.1:3456`
-- optional local UI on `127.0.0.1:1420`
+- local UI on `http://127.0.0.1:1420` for non-Safari default browsers
+- local UI on `https://localhost:1420` when the default browser is Safari
 - browser handoff to `https://www.notioncode.live`
+- trusted localhost certificate provisioning with `mkcert` only when Safari-compatible HTTPS is needed
 
 ## Bridge binaries
 
-The package prefers a prebuilt bridge binary and falls back to a locally built binary when running from source.
+The package prefers a bridge binary bundled inside the `notioncode` npm tarball itself.
+If no bundled bridge is present, it falls back to:
+
+1. an explicitly provided `NOCODE_BRIDGE_BIN`
+2. a cached bridge binary in the companion install root
+3. a locally built bridge when running from source
+4. a GitHub release download as the final fallback
 
 Environment variables:
 
@@ -33,6 +41,11 @@ Environment variables:
 - `NOCODE_CLOUD_URL`
 - `NOCODE_NO_OPEN=1`
 
+## Safari support
+
+When the system default browser is Safari, this package switches the local UI to `https://localhost:1420`.
+That path requires a trusted localhost certificate, so the setup flow will install or download `mkcert` and ask the OS to trust a local CA when needed.
+
 ## Current limitation
 
-This package is implemented inside the source tree and still expects local runtime assets from this repository. It is publication-ready in interface and metadata, but the final standalone distribution still needs packaged runtime assets for the agent sidecar.
+The bridge can be bundled into the `notioncode` package, but the final standalone distribution still needs packaged runtime assets for the agent sidecar and local UI to make the npm install fully self-contained.