@alexleekt/pi-ask-user-glimpse 0.2.1 → 0.3.0

package/CONTRIBUTING.md

@@ -5,8 +5,8 @@ Thanks for your interest in improving `@alexleekt/pi-ask-user-glimpse`!
 ## Development Setup
 
 ```bash
-git clone https://github.com/alexleekt/pi-ask-user-glimpse.git
-cd pi-ask-user-glimpse
+git clone https://github.com/alexleekt/pi-extensions.git
+cd pi-extensions/packages/pi-ask-user-glimpse
 npm install
 ```
 

package/README.md

@@ -5,6 +5,29 @@
 
 A Pi extension that replaces `ask_user` with rich native WebView dialogs powered by [glimpseui](https://npmjs.com/package/glimpseui) and styled with shadcn/ui design tokens.
 
+> **Stop reading terminal walls of text.** This extension turns every `ask_user` call into a beautiful, searchable, keyboard-navigable dialog — complete with markdown context panels, inline descriptions, and dark mode. Your agent asks better questions. You answer faster.
+
+### Use Case: Scoping a New Project
+
+Instead of the agent dumping a wall of questions into the terminal, it opens a native dialog:
+
+```
+┌──────────────────────────────────────────────┐
+│  Which database should we use?                 │
+│  ─────────────────────────────────────────   │
+│  Context: We need something reliable for       │
+│  production.                                  │
+│                                              │
+│  ○ PostgreSQL  · Relational, proven            │
+│  ○ SQLite     · Zero-config, embedded          │
+│  ○ Custom...                                 │
+│                                              │
+│                     [Cancel]  [Submit]        │
+└──────────────────────────────────────────────┘
+```
+
+The agent gets a clean selection back. You get a decision made in seconds, not minutes of scrolling.
+
 ## Features
 
 - **Single-select** — searchable option list with inline descriptions
@@ -14,7 +37,6 @@ A Pi extension that replaces `ask_user` with rich native WebView dialogs powered
 - **Native WebView** — renders in a real window (macOS WKWebView / Linux GTK4 / Windows WebView2)
 - **Terminal fallback** — gracefully degrades to TUI prompts when glimpseui is unavailable
 
-
 ## Install
 
 ```bash
@@ -126,20 +148,20 @@ Each question is shown as a card with a progress bar at the top. Questions with
 |-----------|------|---------|-------------|
 | `question` | `string` | *(required)* | The question to ask |
 | `context` | `string` | — | Additional context shown in a left-side markdown panel |
-| `options` | `Array<string \| {title, description?}>` | — | Options for flat single/multi-select mode |
+| `options` | `Array<string &#124; {title, description?}>` | — | Options for flat single/multi-select mode |
 | `questions` | `Array<{title, description?, options?, allowMultiple?}>` | — | Questions for questionnaire mode. When present, `options` is ignored. Each question can have its own `options` (same shape as top-level `options`) and `allowMultiple`. Questions without `options` render as freeform textareas. |
 | `allowMultiple` | `boolean` | `false` | Allow selecting multiple options |
 | `allowFreeform` | `boolean` | `true` | Show a freeform "Custom" option |
 | `allowComment` | `boolean` | `false` | Collect an optional comment after selection |
 | `allowSkip` | `boolean` | `false` | Allow submitting a questionnaire without answering all questions (questionnaire mode only) |
 | `followCursor` | `boolean` | `false` | Make the 1200×900 dialog follow the terminal cursor |
-| `displayMode` | `"overlay" \| "inline"` | — | Legacy option; ignored (always centered dialog) |
+| `displayMode` | `"overlay" &#124; "inline"` | — | Legacy option; ignored (always centered dialog) |
 
 ## Development
 
 ```bash
-git clone https://github.com/alexleekt/pi-ask-user-glimpse.git
-cd pi-ask-user-glimpse
+git clone https://github.com/alexleekt/pi-extensions.git
+cd pi-extensions/packages/pi-ask-user-glimpse
 npm install
 ```