Welcome to the README Generator for VSCode, an innovative extension designed to create a comprehensive README for your project with the assistance of OpenAI's ChatGPT.
Project Structure Analysis: Automatically scans and sends your project structure to ChatGPT for analysis.
Customizable Readme Generation: ChatGPT will generate a README tailored to your project's specifics.
Language Selection: Choose the language in which you would like your README to be generated.
OpenAI API Key Integration: Use your own OpenAI API key to ensure personalized and secure interactions with ChatGPT.
Section Selection: Have the freedom to select which sections you want to include in your README.
User Consent and Data Security
By using this extension, users agree to send their entire codebase to ChatGPT for analysis and README generation. We understand the sensitivity of this data and wish to emphasize that the user assumes all responsibility for any potential code exposure or project leakage.
Disclaimer: We do not take responsibility for any code or project data that is sent to ChatGPT during the use of this extension. Please ensure that you are comfortable with these terms before proceeding.
How to Use
Install the Extension: Download and install the README Generator from the VSCode Marketplace.
Configuration: Upon executing the extension, enter your OpenAI API key when prompted.
Customization: Select your preferred language for the README and the sections you wish to include.
Generate: Run the extension and let ChatGPT compose a README for you.
This extension was brought to life through the dedicated efforts of the following individuals:
Lyorrei Shono Quintão - Collaboration & Development