ReadmeForge for VS Code
Generate professional README files with AI directly in VS Code.
Features
- Generate README files with a single command
- Multiple templates: standard, minimal, detailed
- Multi-language support: English, Russian, Spanish, German, French, Chinese, Japanese
- Customizable tone and emoji settings
- Automatic GitHub repository detection
Installation
- Open VS Code
- Go to Extensions (Ctrl+Shift+X)
- Search for "ReadmeForge"
- Click Install
Usage
- Open your project in VS Code
- Open Command Palette (Ctrl+Shift+P)
- Type "ReadmeForge: Generate README"
- Enter your API key when prompted (only needed once)
The generated README will be saved and opened automatically.
Commands
| Command |
Description |
ReadmeForge: Generate README |
Generate a new README for the current project |
ReadmeForge: Set API Key |
Update your API key |
Settings
Configure the extension in VS Code settings:
| Setting |
Description |
Default |
readmeforge.apiKey |
Your ReadmeForge API key |
- |
readmeforge.template |
Template style |
standard |
readmeforge.language |
Output language |
en |
readmeforge.tone |
Writing tone |
professional |
readmeforge.includeEmoji |
Include emojis |
true |
Get Your API Key
- Go to readmeforge.app
- Sign in with GitHub
- Navigate to Settings → API Keys
- Generate a new API key
License
MIT
| |
