@ufira/vibma 1.0.0-rc6 → 1.1.0

package/README.md

@@ -1,8 +1,8 @@
-> **[简体中文](./README.zh-CN.md)**
+> **[简体中文](https://github.com/ufira-ai/vibma/blob/main/README.zh-CN.md)**
 
 <div align="center">
 
-<img src="./logo.svg" alt="Vibma" width="120" />
+<img src="https://raw.githubusercontent.com/ufira-ai/vibma/main/logo.svg" alt="Vibma" width="120" />
 
 # Vibma
 
@@ -11,48 +11,78 @@
 https://github.com/user-attachments/assets/bf38e37d-57bb-40b3-a2d1-f89216117c11
 </div>
 
-Let AI agents design directly in Figma — read layouts, create components,
-modify styles, and build entire design systems through conversation.
+> **Project Status:** Vibma is no longer under active development. Figma has
+> launched native MCP capabilities through
+> **[Figma for Agents](https://www.figma.com/blog/the-figma-canvas-is-now-open-to-agents/)**,
+> and the Vibma plugin was not accepted to the Figma marketplace due to
+> "overlap" with this first-party offering.
+>
+> **Vibma is not an official Figma tool.** For production use, we recommend
+> Figma's native MCP integration and encourage you to follow
+> [Figma's official updates](https://www.figma.com/blog/) for the latest
+> agent capabilities.
+>
+> The source code remains available under MIT for learning and reference.
+> We recommend reading [Figma's Terms of Service](https://www.figma.com/tos/)
+> before using Vibma to ensure compliance with their platform policies.
+
+Vibma helps AI agents produce structurally sound Figma files — proper auto-layout, design tokens, component architecture, and reusable design-system patterns.
 
 ---
 
 ## Model Recommendations
 
-Vibma works with any LLM that supports MCP. Based on our [benchmark](https://github.com/ufira-ai/vibma-benchmark):
+Vibma works with any MCP-capable LLM, but model quality matters.
 
-- **Cheap one-shot builds:** GPT-5.3 Codex (medium reasoning) — proper components, all variables bound, clean output for under $1. Degrades on follow-up tasks.
-- **Iterative design work:** GPT-5.3 Codex (xhigh), Gemini 3.1 Pro, or Claude Opus 4.6 — these maintain quality as context grows and handle multi-pass workflows.
-- **Avoid:** Models that skip figma components building (e.g. Cursor Auto, Kimi K2.5) produce frames that look right but aren't structurally usable — no instances, no variants, no library.
+| Tier | OpenAI | Claude | Gemini | Open Source |
+|------|--------|--------|--------|-------------|
+| **Baseline** | GPT 5.2 Medium | Claude Sonnet 4.6 | Gemini 2.5 Flash | Kimi K2.5 |
+| **Recommended** | GPT 5.4 | Claude Opus 4.6 | Gemini 3.1 Pro | — |
 
-## Setup
+- **GPT 5.4** — best overall balance of tool competence and design taste.
+- **Claude Opus 4.6** — strongest tool use, but final designs can feel formulaic.
+- **Gemini 3.1 Pro** — solid middle ground; GPT 5.4 currently edges it on both axes.
+- **Open source** — Kimi K2.5 handles basics (variables, styles) but struggles with complex multi-tool flows.
 
-Two paths:
+## Setup
 
 | | Guide | For |
 |---|---|---|
-| 📦 | [**DRAGME.md**](./DRAGME.md) | Clone the repo, build from source, full control |
-| ☁️ | [**CARRYME.md**](./CARRYME.md) | Install from npm, zero cloning |
-| 📖 | [**Docs**](https://ufira-ai.github.io/Vibma/) | Tool reference with parameters, response schemas, and examples |
+| 📦 | [**DRAGME.md**](https://github.com/ufira-ai/vibma/blob/main/DRAGME.md) | Clone the repo, build from source |
+| ☁️ | [**CARRYME.md**](https://github.com/ufira-ai/vibma/blob/main/CARRYME.md) | Install from npm, zero cloning |
+| 📖 | [**Docs**](https://ufira-ai.github.io/Vibma/) | Tool reference — parameters, response schemas, examples |
 
-Or just paste this to your AI agent and let it figure it out:
+Or paste this to your AI agent:
 
 ```
 Set up Vibma so I can vibe-design in Figma.
 Follow the instructions at https://raw.githubusercontent.com/ufira-ai/vibma/refs/heads/main/CARRYME.md
 ```
 
+## Optional: Library & Image Tools
+
+All core tools work without API keys. Two optional integrations add library discovery and stock photos:
+
+| Env var | Enables | How to get it |
+|---------|---------|---------------|
+| `FIGMA_API_TOKEN` | **Library** — discover published team library components and styles | [Figma Settings > Security > Personal access tokens](https://www.figma.com/developers/api#access-tokens) |
+| `FIGMA_TEAM_ID` | Default team for library discovery | The number in `figma.com/files/team/<ID>/...` |
+| `PEXELS_API_KEY` | **Images** — search and place stock photos | [pexels.com/api/key](https://www.pexels.com/api/key/) (free) |
+
+The Figma PAT requires two scopes: **File content (Read)** and **Team library content (Read)**. See the setup guides for step-by-step instructions with screenshots.
+
 ## Community
 
-[![Discord Banner](https://img.shields.io/discord/1476577401298358315?color=5865F2&label=Join%20the%20Discord&logo=discord&logoColor=white&style=for-the-badge)](https://discord.gg/4XTedZdwV6)
+[![Discord](https://img.shields.io/discord/1476577401298358315?color=5865F2&label=Discord&logo=discord&logoColor=white&style=for-the-badge)](https://discord.gg/4XTedZdwV6)
 
 [GitHub Issues](https://github.com/ufira-ai/vibma/issues) — bugs and feature requests
 
-Vibma is the first open-source project from **[ufira](https://github.com/ufira-ai)** — a platform bridging creators and technology. We believe everyone who wants to create should have access to AI-powered tools, not just developers.
+Vibma is the first open-source project from **[ufira](https://github.com/ufira-ai)** — a platform bridging creators and technology.
 
 ## Acknowledgments
 
-Built on the foundation of [cursor-talk-to-figma-mcp](https://github.com/grab/cursor-talk-to-figma-mcp) by [sonnylazuardi](https://github.com/sonnylazuardi).
+Built on [cursor-talk-to-figma-mcp](https://github.com/grab/cursor-talk-to-figma-mcp) by [sonnylazuardi](https://github.com/sonnylazuardi). Icon search and insertion powered by the [Iconify](https://iconify.design/) public API — an open-source unified icon framework providing 200,000+ icons from 100+ collections. Stock photos by [Pexels](https://www.pexels.com) — free for personal and commercial use. Please read the [Pexels Terms of Service](https://www.pexels.com/terms-of-service/) and credit photographers in production.
 
 ## License
 
-[MIT](./LICENSE)
+[MIT](https://github.com/ufira-ai/vibma/blob/main/LICENSE)