READMEFY is a VS Code extension that uses AI to automatically generate a README.md file for any folder in your workspace. It intelligently summarizes the contents of your files to create a descriptive and helpful README.
Features
AI-Powered README Generation: Creates a README.md file for a folder by summarizing its contents.
Easy to Use: Generate a README with a single click from the explorer context menu or by using the command palette.
Configurable: Choose the Gemini model that best suits your needs.
API Key Validation: Easily check if your Gemini API Key and model are configured correctly.
Installation
Open Visual Studio Code.
Go to the Extensions view (Ctrl+Shift+X).
Search for READMEFY.
Click Install.
Configuration
Before using READMEFY, you need to configure your Gemini API Key and choose a model.
Get your Gemini API Key: You can get a free Gemini API key from Google AI Studio.
Set the API Key in VS Code:
Open VS Code Settings (Ctrl+,).
Search for readmeagent.
In the "Readmeagent: Gemini Api Key" field, enter your Gemini API key.
Choose a Gemini Model (Optional):
In the "Readmeagent: Gemini Model" field, you can specify which Gemini model to use. The default is gemini-2.5-flash. Other options include gemini-pro.
Usage
Generate a README
There are two ways to generate a README file:
From the Explorer:
Right-click on any folder in the VS Code Explorer.
Select "READMEFY: Generate README.md for Folder".
From the Command Palette:
Open the Command Palette (Ctrl+Shift+P).
Type READMEFY: Generate README.md for Folder and press Enter.
You will be prompted to select a folder.
The extension will then analyze the files in the selected folder and generate a README.md file.
Validate Your API Key
To ensure your API key and model are set up correctly, you can use the validation command:
Open the Command Palette (Ctrl+Shift+P).
Type READMEFY: Validate API Key and press Enter.
You will receive a notification indicating whether the configuration is valid.
Contributing
If you encounter any issues or have suggestions for improvement, please feel free to open an issue or submit a pull request on the GitHub repository.
