diff --git a/README.md b/README.md index ced6f82..dd508e3 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,31 @@ gives each one a browsable overview, hierarchy and flat bean lists, and a detail editing and relationship management. It also does cross-project search and simple analytics. Everything reads and writes your on-disk `.beans` files directly; there is no separate database. +## Screenshots + +Every project under your `GIT_ROOT`, with open and total counts broken down by bean type: + + + + The overview, listing five beans projects with their open and total counts broken down by type + + +Inside a project, beans nest by parent so a milestone shows the epics and bugs underneath it. +Filters and sorting sit above the list, and a flat view is one click away: + + + + A project view showing a milestone expanded into nested epics, features, tasks and bugs, above filter and sort controls + + +A bean renders its Markdown body and puts every field inline — type, status, priority and tags +are editable in place, as are its parent and blocking relationships: + + + + A bug's detail view showing its rendered Markdown body, inline-editable fields, its parent epic, and the feature it blocks + + It is a pnpm monorepo with two apps and a shared package: - `apps/server` is a [Hono](https://hono.dev) API server. It discovers `beans` projects, proxies @@ -29,7 +54,7 @@ See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) for how the pieces fit togeth - **Node.js 24+** (see `.nvmrc`) - **pnpm** (see [pnpm.io/installation](https://pnpm.io/installation); this repo was built against - pnpm 10) + pnpm 11) - The **`beans`** CLI binary on your `PATH`. Install it with: ```bash diff --git a/docs/screenshots/bean-detail-dark.png b/docs/screenshots/bean-detail-dark.png new file mode 100644 index 0000000..f3e2ace Binary files /dev/null and b/docs/screenshots/bean-detail-dark.png differ diff --git a/docs/screenshots/bean-detail-light.png b/docs/screenshots/bean-detail-light.png new file mode 100644 index 0000000..2a1f153 Binary files /dev/null and b/docs/screenshots/bean-detail-light.png differ diff --git a/docs/screenshots/overview-dark.png b/docs/screenshots/overview-dark.png new file mode 100644 index 0000000..9d4f7bc Binary files /dev/null and b/docs/screenshots/overview-dark.png differ diff --git a/docs/screenshots/overview-light.png b/docs/screenshots/overview-light.png new file mode 100644 index 0000000..7aa5cae Binary files /dev/null and b/docs/screenshots/overview-light.png differ diff --git a/docs/screenshots/project-dark.png b/docs/screenshots/project-dark.png new file mode 100644 index 0000000..4f2ff22 Binary files /dev/null and b/docs/screenshots/project-dark.png differ diff --git a/docs/screenshots/project-light.png b/docs/screenshots/project-light.png new file mode 100644 index 0000000..d193e36 Binary files /dev/null and b/docs/screenshots/project-light.png differ