README Auto-Generator (Gemini)

Generate a professional README.md for the current workspace using Google Gemini. No forms, no webviews — it scans your files and writes the README.

Features

• Scans project structure and important files
• Uses a strong, opinionated prompt to create a comprehensive README with badges, sections, and API docs
• Safe overwrite prompt if README.md exists
• Configurable model (gemini-1.5-pro default), character limits, and traversal depth

Setup

1. Open this folder in VS Code.
2. Run: npm install
3. Set your API key:
   • VS Code Settings → readmeGemini.apiKey, or
   • Environment: export GEMINI_API_KEY=your_key
4. Press F5 to launch the Extension Development Host.

Usage

• Command Palette → README (Gemini): Auto-generate README.md

Packaging

• npm i -g @vscode/vsce
• vsce package