localdeck 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 1.0.1 — Routing and packaging fixes
+
+### Fixes
+
+- Keep health checks on the detected IPv4 or IPv6 listener, preventing routing to another project using the same port on a different loopback address. Ignore stale health-check results after an upstream change.
+- Run platform-independent forwarder checks on Linux and macOS; restrict native plutil validation to macOS.
+
+### Documentation and packaging
+
+- Remove private repository links from npm metadata and the README. Include configuration, command, dashboard, and MCP documentation in the package.
+- Align the README configuration example with the commands array generated by localdeck init and remove the assumed health endpoint.
+
 ## 1.0.0 — Product launch
 
 ### Project setup and configuration
@@ -12,8 +24,6 @@
 
 ### Runtime and networking
 
-- Keep health checks on the detected IPv4 or IPv6 listener, preventing routing to another project using the same port on a different loopback address. Ignore stale health-check results after an upstream change.
-
 - Run existing development commands through a background daemon, with stable public ports and automatic upstream listener detection.
 - Add native Windows process and TCP listener discovery through PowerShell, plus a dedicated Windows networking CI job. Remove built-in Windows/Linux forwarding without invoking the macOS installer.
 - Provide project-qualified service identities and nickname-based localhost URLs. Reject ambiguous bare service names instead of selecting the wrong project.

package/README.md

@@ -45,19 +45,21 @@ The dashboard is served at `http://localhost:7777` by default. It remembers proj
 
 ## Configure your services
 
-Create a `.localdeck` file in your project root, or edit the one generated by `init`:
+Run `localdeck init` in your application's directory. It detects your package scripts and writes `.localdeck` using a `commands` array. You can then edit the generated commands or add a project nickname in the dashboard.
+
+For example, a project with `dev:api` and `dev:web` scripts can use:
 
 ```json
 {
   "nickname": "platform",
-  "services": [
-    { "name": "api", "run": "npm run dev:api", "ready": "/health" },
+  "commands": [
+    { "name": "api", "run": "npm run dev:api" },
     { "name": "web", "run": "npm run dev:web", "after": "api" }
   ]
 }
 ```
 
-Replace the commands and health endpoint with your project's values. `after` starts the API before the web service and waits for readiness. Omit `ready` to use the default TCP check.
+Use script names that exist in your project. Here, `after` is an optional customization: it starts the API first and waits for its default TCP readiness check before starting web. Add an HTTP `ready` check only if your app exposes that endpoint.
 
 For a non-JavaScript service:
 
@@ -67,7 +69,7 @@ localdeck init --name web --command 'python3 -m http.server {port}'
 
 LocalDeck supplies `PORT` and expands `{port}` to the application's upstream port. It can also detect listening ports on macOS, Linux, and Windows. Configure `upstream` explicitly when detection is unavailable. The optional `port` field is the stable proxy port, not the port your development server should bind.
 
-See [configuration](https://github.com/AdstraliaDev1/local-deck/blob/main/docs/configuration.md) for working directories, profiles, environment references, database services, and advanced readiness checks.
+See configuration (included as `docs/configuration.md`) for working directories, profiles, environment references, database services, and advanced readiness checks.
 
 ## Everyday commands
 
@@ -84,7 +86,7 @@ See [configuration](https://github.com/AdstraliaDev1/local-deck/blob/main/docs/c
 | `localdeck unshare web` | Close the share while keeping the service running. |
 | `localdeck --h` / `localdeck --v` | Show help / version. |
 
-When projects have the same service name, use `project/service` or the exact key shown by `localdeck ps`. See the [full command reference](https://github.com/AdstraliaDev1/local-deck/blob/main/docs/commands.md).
+When projects have the same service name, use `project/service` or the exact key shown by `localdeck ps`. See the full command reference (included as `docs/commands.md`).
 
 ## Share over HTTPS
 
@@ -107,7 +109,7 @@ Enable **Clean URLs** in Settings, or use the prompt above the dashboard footer.
 
 CORS still belongs to your application. `http://localhost:3001`, `http://platform.web.localhost`, and a public HTTPS tunnel URL are different browser origins. Add the frontend origin you actually visit to your API's allowlist. LocalDeck does not rewrite CORS policies or application API URLs.
 
-Windows process discovery and an administrator forwarder are implemented. Windows UAC installation, removal, and reboot persistence still need manual validation on Windows; see [platform details](https://github.com/AdstraliaDev1/local-deck/blob/main/docs/dashboard.md#windows).
+Windows process discovery and an administrator forwarder are implemented. Windows UAC installation, removal, and reboot persistence still need manual validation on Windows; see platform details (included as `docs/dashboard.md`).
 
 ## Connect a coding agent
 
@@ -124,7 +126,7 @@ Add LocalDeck to an MCP client's server configuration:
 }
 ```
 
-Use `localdeck mcp --project <id>` to restrict access to one remembered project. See [MCP setup and tools](https://github.com/AdstraliaDev1/local-deck/blob/main/docs/mcp.md).
+Use `localdeck mcp --project <id>` to restrict access to one remembered project. See MCP setup and tools (included as `docs/mcp.md`).
 
 ## Troubleshooting
 
@@ -141,13 +143,12 @@ Use `localdeck mcp --project <id>` to restrict access to one remembered project.
 
 ## Documentation
 
-- [Configuration](https://github.com/AdstraliaDev1/local-deck/blob/main/docs/configuration.md)
-- [CLI reference](https://github.com/AdstraliaDev1/local-deck/blob/main/docs/commands.md)
-- [Dashboard and platform support](https://github.com/AdstraliaDev1/local-deck/blob/main/docs/dashboard.md)
-- [MCP integration](https://github.com/AdstraliaDev1/local-deck/blob/main/docs/mcp.md)
-- [Development](https://github.com/AdstraliaDev1/local-deck/blob/main/docs/development.md) and [architecture](https://github.com/AdstraliaDev1/local-deck/blob/main/docs/architecture.md)
-- [Changelog](https://github.com/AdstraliaDev1/local-deck/blob/main/CHANGELOG.md) and [release instructions](https://github.com/AdstraliaDev1/local-deck/blob/main/docs/releasing.md)
+- Configuration (included as `docs/configuration.md`)
+- CLI reference (included as `docs/commands.md`)
+- Dashboard and platform support (included as `docs/dashboard.md`)
+- MCP integration (included as `docs/mcp.md`)
+- Changelog (included as `CHANGELOG.md`)
 
 ## License
 
-Free for personal and commercial use, including building and selling your own products. You may not sell LocalDeck, charge for access to it, or claim it as your own product. Modification and redistribution require permission under the [custom proprietary license](https://github.com/AdstraliaDev1/local-deck/blob/main/LICENSE). Bundled dependencies retain their own licenses; the package includes `THIRD_PARTY_NOTICES.md`.
+Free for personal and commercial use, including building and selling your own products. You may not sell LocalDeck, charge for access to it, or claim it as your own product. Modification and redistribution require permission under the custom proprietary license (included as `LICENSE`). Bundled dependencies retain their own licenses; the package includes `THIRD_PARTY_NOTICES.md`.