This Visual Studio Code extension allows you to generate a professional README.md file instantly using AI (via OpenRouter API).
A simple form-based interface helps you input your project details. Within seconds, the extension creates and saves a complete README.md file in your project folder – with no manual formatting required.
✅ Features
✨ AI-Powered: Uses Zephyr/GPT models via OpenRouter to generate content.
🧾 Well-structured output: README includes standard sections:
Description
Tech Stack
Setup
Usage
Author
License
Contributing
⚡ Auto Save & Preview: README.md is saved to your workspace and opened automatically.
🧠 Smart defaults: Uses your configured API key or falls back to default key if none is set.
⌨️ Keyboard Shortcut: Launch the form quickly using Ctrl+Alt+R.
💡 How to Use
Open your project folder in VS Code.
Press Ctrl+Shift+P (or Cmd+Shift+P on Mac) to open the Command Palette.
Run the command: 📄 Generate README using AI
Or use shortcut:Ctrl+Alt+R
A form will open — fill in the following fields:
Project Name
Description
Tech Stack
Setup Instructions
Usage
Author
License
Contributing
Click Generate README.
The extension will:
📝 Generate the README using OpenRouter API
💾 Save README.md in your current workspace folder
🧭 Open the README file in the editor for preview
❌ Close the generator form automatically
🔐 API Key Requirement
The extension uses the OpenRouter API to generate content.
To function, it needs an API key, which you can provide in one of two ways:
Option 1: VS Code Settings (Recommended)
Open Settings (Ctrl+,)
Search for OpenRouter API Key
Set your key under: Instant README Creator › ReadmeGen: Api Key
