Skip to content

Commit 6ce6bac

Browse files
committed
docs: enhance README with introductory text and update documentation links
1 parent f340d1c commit 6ce6bac

File tree

2 files changed

+34
-10
lines changed

2 files changed

+34
-10
lines changed

README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
# Pi Mobile
22

3-
An Android client for the [Pi coding agent](https://github.com/badlogic/pi-mono). Control your coding sessions from your phone over Tailscale.
3+
> **Your Pi coding agent, in your pocket.**
4+
> Run and steer coding sessions from Android anywhere over Tailscale.
5+
6+
Pi Mobile is an Android client for the [Pi coding agent](https://github.com/badlogic/pi-mono). It gives you live session control when you’re away from your laptop.
7+
8+
## Demo (WIP)
9+
10+
▶️ **Streamable demo:** https://streamable.com/jngtjp *(WIP)*
11+
12+
## Screenshots
13+
14+
| Chat + tools | Sessions + controls |
15+
|---|---|
16+
| ![Pi Mobile chat and tool streaming screenshot](https://i.imgur.com/sKXfkOe.png) | ![Pi Mobile session browsing screenshot](https://i.imgur.com/JBFchOQ.png) |
417

518
## What This Does
619

@@ -19,13 +32,22 @@ Pi runs on your laptop. This app lets you:
1932

2033
The connection goes over Tailscale, so it works anywhere without port forwarding.
2134

22-
## Architecture
35+
## High-Level Design
2336

24-
```
25-
Phone (this app) <--Tailscale--> Laptop (bridge) <--local--> pi --mode rpc
37+
```mermaid
38+
flowchart LR
39+
Phone["Android app\nPi Mobile"]
40+
Bridge["Node.js bridge\nWebSocket ↔ pi stdio"]
41+
Pi["pi --mode rpc\n(on laptop)"]
42+
Sessions["Session files\n~/.pi/agent/sessions/*.jsonl"]
43+
44+
Phone <-->|"WebSocket + token auth\nover Tailscale"| Bridge
45+
Bridge <-->|"JSON lines\nstdin/stdout RPC"| Pi
46+
Pi <--> Sessions
47+
Bridge -. "indexes sessions" .-> Sessions
2648
```
2749

28-
The bridge is a small Node.js service that translates WebSocket to pi's stdin/stdout JSON protocol. The app connects to the bridge, not directly to pi.
50+
The bridge is a small Node.js service that translates WebSocket to pi's stdin/stdout JSON protocol. The app connects to the bridge, not directly to pi. For deeper diagrams, see [docs/architecture.md](docs/architecture.md).
2951

3052
## Documentation
3153

docs/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ This directory contains human-facing documentation for the Pi Mobile app and bri
44

55
## Table of Contents
66

7+
- [Product Overview, Demo, and Screenshots (README)](../README.md)
78
- [Architecture (Mermaid diagrams)](architecture.md)
89
- [Architecture Decision Records (ADRs)](adr/README.md)
910
- [Codebase Guide](codebase.md)
@@ -17,8 +18,9 @@ This directory contains human-facing documentation for the Pi Mobile app and bri
1718

1819
- `docs/ai/` contains planning/progress notes generated during implementation.
1920
- For day-to-day development and maintenance, start with:
20-
1. [Architecture (Mermaid diagrams)](architecture.md)
21-
2. [Architecture Decision Records (ADRs)](adr/README.md)
22-
3. [Codebase Guide](codebase.md)
23-
4. [Custom Extensions](extensions.md)
24-
5. [Bridge Protocol Reference](bridge-protocol.md)
21+
1. [Product Overview, Demo, and Screenshots (README)](../README.md)
22+
2. [Architecture (Mermaid diagrams)](architecture.md)
23+
3. [Architecture Decision Records (ADRs)](adr/README.md)
24+
4. [Codebase Guide](codebase.md)
25+
5. [Custom Extensions](extensions.md)
26+
6. [Bridge Protocol Reference](bridge-protocol.md)

0 commit comments

Comments
 (0)