Skip to content

First version

Latest
Latest
Compare
Choose a tag to compare
@JonatasMSS JonatasMSS released this 20 Nov 01:54
1.0.0
f885d55

Release Notes for Smart Readme Generator 🧠

🚀 Version Highlights

The Smart Readme Generator is a powerful Visual Studio Code extension that leverages Generative AI to create professional and detailed README.md files tailored to your project's file structure. Say goodbye to manual documentation creation and let AI streamline the process for you!

✨ Key Features

  • Automated Readme Generation: Scans your workspace's file tree and generates a well-structured README.md file.
  • Customizable with AI: Utilizes Gemini AI to craft descriptions based on your specific project details.
  • Command Suite: Includes essential commands for managing API tokens and navigating your workspace.
  • Easy Setup: Configure your API key effortlessly and start generating immediately.

🛠️ New Commands

Command Description
Generate Readme Creates a new README.md based on your workspace structure. (Requires an API key)
Show Api Displays the currently configured API token.
Set Api Token Allows you to set a new API token for AI integration.
Reset Api Token Removes the existing API token from the configuration.
Get Current Dir Displays the current workspace directory.

🚧 Current Limitations

Feature Status
Ability to read archive content ❗
Option to select from multiple README versions ❗
Enhanced AI prompt for improved README quality ❗

📖 How It Works

  1. Setup: Obtain your API key from Google AI Studio and configure it using the Set Api Token command.
  2. Workspace Analysis: The extension scans your workspace's file tree and generates a structured JSON representation.
  3. AI Integration: The JSON is sent to Gemini AI, which returns a markdown template based on your project details.
  4. Save & Use: The generated README is saved as a new file, README.md, in your workspace.

🤝 Contribute to the Project

We welcome your ideas and contributions! Here's how you can get involved:

  1. Fork the repository.
  2. Clone your fork and create a new feature branch.
  3. Make your improvements, push the branch, and submit a pull request.

Ready to elevate your project documentation? Download the Smart Readme Generator now and experience AI-driven productivity!

Assets 2
Loading