Repo README AI

Analyzes your repository (file structure + key config/entry files) and generates a README.generated.md with an architecture overview, tech stack, and setup instructions — powered by an LLM.

Features

• Scans your project respecting .gitignore
• Identifies key files (package.json, requirements.txt, entry points, Dockerfiles, etc.)
• Generates a structured README: summary, tech stack, folder purpose, entry points, setup, run instructions
• Your API key is stored in VS Code's encrypted secret storage — never hardcoded, never bundled

Usage

1. Open a folder/workspace in VS Code
2. Run Repo README AI: Generate README from the Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
3. On first run, paste your Groq API key when prompted (get one free at console.groq.com)
4. Review README.generated.md and rename it to README.md if you're happy with it

Run Repo README AI: Reset API Key to clear the stored key.

Requirements

• A Groq API key (free tier available)

Extension Settings

None yet — API key is managed via secret storage, not settings.

Known Limitations

• Only scans text files; binary files are skipped
• Caps at ~300 files and reads a fixed set of "priority" files in full, everything else by name only
• Large monorepos may need scoping to a subfolder in a future version

Release Notes

0.0.1

Initial release.