docs: add README with setup, keybindings, and layout preview

Author: gitcoder89431

README.md

@@ -1,82 +1,108 @@
-# go-tui-template
+# meshd
 
-Personal base template for Go terminal UIs built on the [Charm](https://charm.sh) stack.
+A terminal UI for [Syncthing](https://syncthing.net) — monitor folders and devices, view sync status, and manage pending connections, all without leaving your terminal.
 
-## Stack
+Built on the same Go/Bubbletea stack as [tuitube](https://github.com/gitcoder89431/tuitube).
 
-- [Bubble Tea v2](https://charm.land/bubbletea/v2) — TUI framework
-- [Lip Gloss v2](https://charm.land/lipgloss/v2) — styling and layout
-- [Bubbles](https://github.com/charmbracelet/bubbles) — components (table, spinner, list, etc.)
-- [GoReleaser v2](https://goreleaser.com) — release pipeline
+## What it looks like
+
+```
+┌─ Dashboard ──────────────────────────────────────────────────┐
+│ Folders /////////////////  Devices ////////////////////////// │
+│ Projects   ✓ Up to Date    MacBook    ● Online               │
+│ Photos     ↻ Syncing 87%   Phone      ↻ Syncing 43%          │
+│ Docs       ✓ Up to Date    Work PC    ○ Offline              │
+│ ──────────────────────────────────────────────────────────── │
+│   Projects — /home/dev/Projects                              │
+│   Shared with 2 device(s):                                   │
+│     └─ MacBook                                               │
+│     └─ Phone                                                 │
+└──────────────────────────────────────────────────────────────┘
+```
+
+## Features
+
+- **Dashboard** — split folders/devices view with live sync status badges, detail panel for the selected item
+- **Pending** — lists devices and folders waiting to be accepted or dismissed
+- **Themes** — 15+ built-in themes via `ctrl+k` → Themes
+- **Command palette** — `ctrl+k` for quick navigation
+- **Auto-polls** every 10 seconds; press `r` to force refresh
+- **Auto-reads API key** from Syncthing config — no manual setup
 
-## What's included
+## Requirements
 
-- Header / sidebar / main / footer layout
-- Screen router with sidebar navigation
-- Command palette (`ctrl+k`)
-- Global keybindings and help overlay (`?`)
-- Theme system with 15+ built-in themes (`ctrl+t` to cycle)
-- Debug log screen
-- GoReleaser config + GitHub Actions release workflow (push tag or manual bump)
+- [Syncthing](https://syncthing.net) installed and running
+- Go 1.26+
 
-## Starting a new project
+## Install
 
 ```bash
-gh repo create my-new-app --template gitcoder89431/go-tui-template --clone
-cd my-new-app
+# From source
+git clone https://github.com/gitcoder89431/meshd
+cd meshd
+go install ./cmd/meshd
 
-# Rename the module and binary
-OLD=github.com/gitcoder89431/go-tui-template
-NEW=github.com/yourname/my-new-app
-find . -type f -name "*.go" -exec sed -i "s|$OLD|$NEW|g" {} +
-sed -i "s|$OLD|$NEW|g" go.mod
-sed -i "s|go-tui-template|my-new-app|g" internal/config/config.go .goreleaser.yaml Dockerfile .github/workflows/publish.yml
-mv cmd/go-tui-template cmd/my-new-app
+# Or download a release binary (see Releases)
+```
+
+## Setup
+
+Start Syncthing if it isn't already running:
+
+```bash
+# Linux (systemd)
+systemctl --user enable --now syncthing
+
+# macOS
+brew services start syncthing
+```
 
-# Update README and AGENTS.md
+Then just run:
 
-go mod tidy
-go run ./cmd/my-new-app
+```bash
+meshd
 ```
 
-## Adding a screen
+meshd reads your Syncthing API key automatically from the default config location (`~/.local/state/syncthing/config.xml` on Linux, `~/Library/Application Support/Syncthing/config.xml` on macOS). No copy-pasting required.
 
-1. Create a file in `internal/screens/`.
-2. Implement the `screens.Screen` interface: `Init`, `Update`, `View`, `Title`, and `KeyBindings`.
-3. Register the screen in `registerScreens` in `internal/app/app.go`.
-4. Add the screen ID to the `preferred` slice in `refreshScreenOrder` if it belongs in the primary sidebar.
-5. Register a command in `registerCommands` if the screen should be reachable from `ctrl+k`.
-6. Run `go test ./...` and `go build ./cmd/go-tui-template`.
+### Options
+
+```
+meshd --url http://127.0.0.1:8384   # custom Syncthing URL (default)
+meshd --key <api-key>               # override API key
+meshd --version                     # print version
+```
+
+## Keybindings
+
+| Key | Action |
+|-----|--------|
+| `tab` / `h` / `l` | Switch between Folders and Devices pane |
+| `j` / `↓` | Move down |
+| `k` / `↑` | Move up |
+| `r` | Force refresh from Syncthing |
+| `ctrl+k` | Open command palette |
+| `?` | Help overlay |
+| `q` / `ctrl+c` | Quit |
+
+## Stack
+
+- [Bubble Tea v2](https://charm.land/bubbletea/v2) — TUI framework
+- [Lip Gloss v2](https://charm.land/lipgloss/v2) — styling and layout
+- [Syncthing REST API](https://docs.syncthing.net/dev/rest.html) — no extra dependencies, plain HTTP
 
 ## Development
 
 ```bash
-go run ./cmd/go-tui-template   # run
-go test ./...                   # test
-go build ./cmd/go-tui-template  # build check
+go run ./cmd/meshd    # run
+go test ./...         # test
+go build ./cmd/meshd  # build check
 ```
 
 ## Release
 
 Releases are handled by GoReleaser via GitHub Actions.
 
 ```bash
-# Auto-trigger on tag push
 git tag v0.1.0 && git push origin v0.1.0
-
-# Or use the manual publish workflow (patch/minor/major bump)
-gh workflow run publish.yml -f bump=patch
 ```
-
-## Notes
-
-- `Width(n)` / `Height(n)` in Lip Gloss v2 set the **total outer size** including borders. Do not pre-subtract `GetFrameSize()` before passing to these methods.
-- Some Bubbles components still return Bubble Tea v1 types — check for type mismatches when wiring new ones into the model.
-
-## Credits
-
-Built on packages by **[elpdev](https://github.com/elpdev)**:
-- `tuitheme` — 14 built-in themes with a clean palette system
-- `tuimod` — `Screen` interface and `KeyCapturer`
-- `tuilayout` — responsive header/sidebar/main/footer dimensions
-- `tuipalette` — command palette with theme preview