Readogen is an AI-based VSCode extension that leverages the power of the GPT-3.5-turbo OpenAI model to effortlessly generate README.md files for your GitHub projects. Say goodbye to manual writing and tedious documentation—let Readogen handle it for you!
🌟 Features and Benefits
1. AI-Powered Readme Generation
Utilizes the advanced GPT-3.5-turbo OpenAI model for intelligent and context-aware readme generation.
Saves time and effort by automating the process of creating project documentation.
2. Effortless Setup
Easy activation process through VSCode settings.
Simply enter your OpenAI API key in the settings to unlock the power of Readogen.
3. User-Friendly Interface
Intuitive command palette integration for seamless usage.
Guided prompts for entering project title, description, and tech stack.
4. Customizable Tech Stack
Specify your project's tech stack, and Readogen will automatically include relevant badges in the generated readme.
5. Time-Saving Readme Creation
Instantly generate a well-structured and professionally formatted README.md file with a few simple steps.
📖 Usage Instructions
Get Your OpenAI API Key
If you don't have an OpenAI API key, you can obtain one here. Follow the instructions on the OpenAI platform to get your API key.
Activate the Extension
Navigate to VSCode settings > Extensions > Readogen.
Enter your OpenAI API key to activate the extension.
Access Readogen in the Command Palette
Open the command palette using Ctrl + Shift + P on Windows/Linux or Cmd + Shift + P on macOS.
Search for Readogen and select it from the list.
Enter Project Details
Provide the project title, project description, and tech stack when prompted.
Sit back and relax as Readogen swiftly generates a README.md file with all the necessary information and badges.
With Readogen, documentation becomes a breeze, allowing you to focus more on coding and less on writing lengthy project descriptions. Let the AI revolutionize your readme creation process!