The Readme Architect

Generate professional, context-aware README.md files for your projects using Google's Gemini 3 Flash AI.

The Readme Architect scans your project structure, understands your code, and writes a comprehensive documentation file for you in seconds.

Features

• ⚡ Instant Generation: Uses Gemini 3 Flash (gemini-3-flash-preview) for blazing fast results.
• 🧠 Context Aware: Reads your package.json, Cargo.toml, and source files to understand what your project actually does.
• 📂 Smart Scanning: Recursively walks your directory tree (ignoring node_modules and hidden files).
• ✨ Professional Formatting: Generates clean, standard Markdown.

Pro Features (Paid)

Unlock the full power of The Readme Architect with a Pro License:

• 📊 Architecture Diagrams: Automatically generates Mermaid.js diagrams visualizing your project's structure.
• 🛡️ Badges: Adds professional build, license, and technology badges.
• 📝 Detailed Sections: Includes API Documentation, Contributing Guidelines, and more.

How to Use

1. Open any project in VS Code.
2. Right-click on the folder you want to document in the Explorer.
3. Select "Generate Readme".
4. Watch as the AI analyzes your code and drafts your documentation!

Requirements

• A Google Gemini API Key (Free).
• (Optional) A Gumroad License Key for Pro features.

Extension Settings

• readmeArchitect.geminiApiKey: Your Google Gemini API Key.
• readmeArchitect.licenseKey: Your Pro License Key.

Enjoying the extension? Leave a review!