@deepseekharness-mobile/companion 0.1.0 → 0.1.1

package/README.md

@@ -1,9 +1,27 @@
-# @deepseekharness-mobile/companion
+<div align="center">
+  <img src="https://raw.githubusercontent.com/joseph12n/dsh-mobile/main/docs/assets/logo.png" width="88" alt="DSH Mobile" />
 
-The [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) host plugin for **DSH
-Mobile**: a WebSocket bridge on port 6768, QR and device-token pairing, the embedded PWA and the
-session/transcript/question/command/provider/device features described in the
-[root README](https://github.com/joseph12n/dsh-mobile).
+  <h1>@deepseekharness-mobile/companion</h1>
+
+  <p><strong>The host plugin for DSH Mobile.</strong><br />
+  Serves the PWA, pairs phones and bridges the <code>dsh-mobile/1</code> contract to DeepSeek
+  Harness — loopback-only, one token per device, no cloud in between.</p>
+
+  <p>
+    <a href="https://www.npmjs.com/package/@deepseekharness-mobile/companion"><img src="https://img.shields.io/npm/v/@deepseekharness-mobile/companion?label=npm&color=4D6BFE" alt="npm" /></a>
+    <a href="https://www.npmjs.com/package/@deepseekharness-mobile/companion"><img src="https://img.shields.io/npm/dm/@deepseekharness-mobile/companion?color=4D6BFE" alt="Downloads" /></a>
+    <a href="https://github.com/joseph12n/dsh-mobile/actions/workflows/ci.yml"><img src="https://github.com/joseph12n/dsh-mobile/actions/workflows/ci.yml/badge.svg" alt="CI" /></a>
+    <a href="https://sonarcloud.io/summary/new_code?id=joseph12n_dsh-mobile"><img src="https://sonarcloud.io/api/project_badges/measure?project=joseph12n_dsh-mobile&metric=alert_status" alt="Quality Gate" /></a>
+    <a href="https://github.com/joseph12n/dsh-mobile/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-4D6BFE.svg" alt="License" /></a>
+    <a href="https://github.com/deepseek-ai/deepseek-harness"><img src="https://img.shields.io/badge/DeepSeek%20Harness-companion-4D6BFE?logo=deepseek&logoColor=white" alt="DeepSeek Harness" /></a>
+    <a href="https://github.com/joseph12n/dsh-mobile/blob/main/docs/phone-setup.md"><img src="https://img.shields.io/badge/PWA-installable-5A0FC8?logo=googlechrome&logoColor=white" alt="PWA" /></a>
+  </p>
+
+  <p>
+    <img src="https://raw.githubusercontent.com/joseph12n/dsh-mobile/main/docs/assets/session.png" width="215" alt="A live turn with the agent activity panel" />
+    <img src="https://raw.githubusercontent.com/joseph12n/dsh-mobile/main/docs/assets/settings.png" width="215" alt="Model providers and paired devices" />
+  </p>
+</div>
 
 ## Install
 
@@ -11,15 +29,51 @@ session/transcript/question/command/provider/device features described in the
 dsh profile add @deepseekharness-mobile/companion
 ```
 
-The profile reads the bundle's `cordis.patch.yml` and mounts the plugin. Restart DSH after the
-install; the PWA is served at `/` and pairing at `/pair`. For the tailnet and phone steps, see
-[docs/phone-setup.md](https://github.com/joseph12n/dsh-mobile/blob/main/docs/phone-setup.md).
+The profile reads the bundle's `cordis.patch.yml`, mounts the plugin and serves the embedded
+PWA on `127.0.0.1:6768`. Restart DSH afterwards, run `/mobile` in a session and open the link
+on the phone; the PWA installs from the browser menu.
+
+The listener is **loopback-only** by design: the phone reaches it through the tailnet name with
+`tailscale serve`, which provides HTTPS and a secure context. The full path, with the usual
+problems, is in
+[`docs/phone-setup.md`](https://github.com/joseph12n/dsh-mobile/blob/main/docs/phone-setup.md).
+
+## What the phone gets
+
+- **Live transcript** with paged history, separated reasoning and streaming events.
+- **Questions and approvals**, including the blocking `ask_user_question`, in an inline card.
+- **Agent activity**: goal and round, running subagents and open tasks in a floating panel that
+  does not shrink the conversation.
+- **Slash commands** from the composer, with the result outside the model transcript.
+- **Model providers**: test a key and connect it; the key is stored on the host and never comes
+  back, and endpoints, headers, model overrides and OAuth stay on the desktop.
+- **Paired devices**: last seen, revoke and forget, with the host revoking first.
+- **Sessions, folders, model choice**, write and cancel, and an installable PWA with four
+  locales.
+
+The full feature tour, the architecture and the security model live in the
+[repository README](https://github.com/joseph12n/dsh-mobile#readme).
 
 ## Security
 
-The listener binds loopback by default and a phone must pair before any frame is accepted.
-Device tokens can be revoked from the phone or from the host devices file. Do not expose the
-listener directly to the internet; use the tailnet or a reverse proxy with TLS.
+- **Loopback only.** The listen address is a constant, not an option; the tailnet name is the
+  only supported path and LAN access is not implemented.
+- **Pair before anything.** The QR carries a single-use code in the URL fragment, valid for
+  10 minutes and never written to a log; redeeming it creates a device token stored as a hash.
+- **One token per device.** Revoking one cuts its sockets and does not affect the others.
+- **The host decides.** Capabilities are negotiated in `hello.ok`; the client cannot see or do
+  what the server does not send.
+
+## Documentation
+
+- [Repository](https://github.com/joseph12n/dsh-mobile) — the product, the features and the
+  screenshots.
+- [Phone setup](https://github.com/joseph12n/dsh-mobile/blob/main/docs/phone-setup.md) —
+  Tailscale, pairing and the usual problems.
+- [Architecture](https://github.com/joseph12n/dsh-mobile/blob/main/docs/architecture.md) — why
+  it is built this way.
+- [`@deepseekharness-mobile/protocol`](https://www.npmjs.com/package/@deepseekharness-mobile/protocol)
+  — the wire contract, also on npm.
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deepseekharness-mobile/companion",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "DSH host plugin: WebSocket bridge, QR pairing and device tokens for DSH Mobile",
   "license": "MIT",
   "type": "module",
@@ -38,7 +38,7 @@
     "cordis.patch.yml"
   ],
   "dependencies": {
-    "@deepseekharness-mobile/protocol": "0.1.0",
+    "@deepseekharness-mobile/protocol": "0.1.1",
     "qrcode": "^1.5.4",
     "ws": "^8.18.3"
   },