@khanglvm/relay 0.5.2 → 0.5.4

package/README.md

@@ -16,36 +16,51 @@ note, Submit — and the agent picks up your answers and keeps going:
 
 ![Full flow: Claude Code opens a relay board, the user answers, comments and submits, the agent continues](https://raw.githubusercontent.com/khanglvm/relay/main/docs/assets/demo.gif)
 
-**Visual answer options** — every choice carries its own chart/image/diagram, so you pick by looking:
+## Quick start
 
-![Visual answer options: clicking between two options that each carry their own chart](https://raw.githubusercontent.com/khanglvm/relay/main/docs/assets/feature-options.gif)
+```sh
+# the rly CLI
+npm i -g @khanglvm/relay
 
-**Comment on anything** — click a chart bar, diagram node, table cell, or sentence; comments return to the agent with the answers:
+# the agent skill → every detected agent (Claude Code, Codex, Cursor, …)
+npx skills add khanglvm/relay --skill relay --all
 
-![Clicking a chart bar and leaving an inline comment](https://raw.githubusercontent.com/khanglvm/relay/main/docs/assets/feature-annotate.gif)
+# enforce it (recommended) — a skill alone is an ignorable hint; append relay's
+# short usage rules to your agent's global instructions (per-agent commands below)
+rly skill rules
+```
 
-**Full-screen any visual** — one button above every chart, diagram, table, image, and prototype:
+That's it. Next time your agent needs a decision or wants to show you a plan,
+it opens a board like the ones above and waits for your Submit.
 
-![Expanding a diagram into the full-screen overlay](https://raw.githubusercontent.com/khanglvm/relay/main/docs/assets/feature-fullscreen.gif)
+### Tell your agent to actually use it
 
-| Light theme | Dark theme |
-|---|---|
-| ![relay board light theme](https://raw.githubusercontent.com/khanglvm/relay/main/docs/assets/board-light.png) | ![relay board dark theme](https://raw.githubusercontent.com/khanglvm/relay/main/docs/assets/board-dark.png) |
+`rly skill rules` prints relay's short usage rules. A skill is just an ignorable
+hint — these rules in the file your agent *always* reads are what make it reach for
+relay. Append them to your agent's **global** instructions:
 
-| Annotation popover | Mobile |
-|---|---|
-| ![Annotation comment on a chart bar](https://raw.githubusercontent.com/khanglvm/relay/main/docs/assets/annotations.png) | ![Mobile view at 375px](https://raw.githubusercontent.com/khanglvm/relay/main/docs/assets/mobile.png) |
+```sh
+rly skill rules >> ~/.claude/CLAUDE.md          # Claude Code
+rly skill rules >> ~/.codex/AGENTS.md           # Codex
+rly skill rules >> ~/.gemini/GEMINI.md          # Gemini CLI
+rly skill rules >> ~/.config/opencode/AGENTS.md # OpenCode
+```
 
-## Quick start
+Cursor and GitHub Copilot keep global rules in a settings panel, not a file — run
+`rly skill rules` and paste the output into Cursor's *Settings → Rules → User Rules*
+or Copilot's custom-instructions.
+
+<details>
+<summary>More agents</summary>
 
 ```sh
-npm i -g @khanglvm/relay                  # the rly CLI
-npx -y skills add khanglvm/relay -g -y    # the agent skill (Claude Code, Codex, Cursor, …)
-rly skill rules >> ~/.claude/CLAUDE.md    # optional: skills are ignorable hints — this enforces usage (or >> AGENTS.md)
+rly skill rules >> ~/.codeium/windsurf/memories/global_rules.md # Windsurf
+rly skill rules >> ~/.factory/AGENTS.md                         # Droid (Factory)
 ```
 
-That's it. Next time your agent needs a decision or wants to show you a plan,
-it opens a board like the ones above and waits for your Submit.
+Any other agent: run `rly skill rules` and paste the block into whatever file or
+settings panel it reads as global instructions.
+</details>
 
 ## What it improves
 

package/docs/AGENT.md

@@ -479,4 +479,4 @@ call rather than calling it repeatedly in a loop.
 - For sensitive PlantUML diagrams, set `"server": "https://your-server"` to avoid
   sending source to the public plantuml.com server.
 - Bundled universal skill (Claude Code, Codex, any SKILL.md-aware agent):
-  `rly skill install` — or `npx skills add khanglvm/relay`.
+  `rly skill install` — or `npx skills add khanglvm/relay --skill relay --all`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@khanglvm/relay",
-  "version": "0.5.2",
+  "version": "0.5.4",
   "description": "Browser-based question boards with rich blocks (markdown, charts, mermaid, tables, code, sandboxed HTML) and element-level annotations for AI coding agents (Claude Code, Codex, …): ask users structured questions, present interactive visuals, collect inline comments, wait for submit, read answers as JSON.",
   "keywords": [
     "ai-agents",
@@ -34,6 +34,7 @@
     "vendor",
     "skills",
     "docs",
+    "!docs/assets",
     "README.md",
     "LICENSE"
   ],

package/src/cli.js

@@ -782,9 +782,10 @@ function cmdSkill(rest) {
   bundled at:  ${SKILL_SRC}
   install it:  rly skill install            # auto-detects ~/.claude, ~/.codex, ~/.agents
                rly skill install --target claude|codex|both|<dir>
-  from repo:   npx skills add khanglvm/relay
-  enforce it:  rly skill rules >> CLAUDE.md # or AGENTS.md — short always-read rules,
-                                            # because a skill alone is an ignorable hint
+  from repo:   npx skills add khanglvm/relay --skill relay --all
+  enforce it:  rly skill rules              # short always-read rules — paste into the file your
+                                            # agent reads (CLAUDE.md, AGENTS.md, .cursor/rules, …);
+                                            # a skill alone is an ignorable hint
 
 The skill teaches your agent the board spec format (questions + rich blocks +
 annotations), the blocking vs --detach patterns, and visualization sizing.
@@ -853,7 +854,7 @@ NOTES        answers & annotations autosave in real time (drafts survive timeout
 
 AI AGENTS    run \`rly agent\` for the complete machine-oriented guide.
              a universal skill is bundled — install with \`rly skill install\`
-             (or from the repo: npx skills add khanglvm/relay)`);
+             (or from the repo: npx skills add khanglvm/relay --skill relay --all)`);
   return 0;
 }