readmai

🤖 Gemini-Powered AI README Generator

This project provides a command-line interface (CLI) tool that leverages Google's Gemini AI to automatically generate comprehensive README.md files for your projects. By analyzing your local project files, it intelligently crafts a structured and professional README that covers essential sections like project title, description, tech stack, features, installation, usage, folder structure, contribution guidelines, and licensing.

✨ Features

• AI-Powered README Generation: Utilizes the Google Gemini AI model (gemini-2.5-flash) to generate detailed README.md content.
• Local File Analysis: Reads and processes project files within the current working directory to understand the project's context.
• Configurable Depth: Scans files up to a configurable depth (default: 2) to prevent excessive processing.
• Intelligent Folder Ignoring: Skips common development directories like node_modules, .git, dist, and build during analysis.
• Structured Output: Ensures the generated README.md includes all standard sections expected in a professional project documentation.
• Model Listing Utility: Includes a separate script to list available Gemini models, aiding in model selection and debugging.

🚀 Tech Stack

• Node.js: The JavaScript runtime environment.
• Google Gemini API: The core AI service used for content generation.
• @google/generative-ai: Official Node.js SDK for interacting with the Gemini API.
• dotenv: For loading environment variables from a .env file.

⚙️ Installation

To set up and run this project locally, follow these steps:

• Clone the repository:

  git clone https://github.com/your-username/ai-readme-gen.git
  cd ai-readme-gen
  

• Install dependencies:

  npm install
  

• Configure API Key: Obtain a Google Gemini API key from the Google AI Studio. Create a .env file in the project root directory and add your API key:

  GEMINI_API_KEY=YOUR_GEMINI_API_KEY_HERE
  

💡 Usage

Generating a README

Navigate to the root directory of the project you want to generate a README.md for, then run the index.js script:

node /path/to/ai-readme-gen/index.js

Alternatively, you can place this tool in your global PATH or create a symbolic link for easier access.

The script will analyze your project files and create a README.md in the current directory.

Listing Available Gemini Models

To see a list of available Gemini models that you could potentially use with the API, run the list-models.js script:

node /path/to/ai-readme-gen/list-models.js

📁 Folder Structure

.
├── .env                  # Environment variables (e.g., GEMINI_API_KEY)
├── index.js              # Main script for generating READMEs
├── list-models.js        # Utility script to list available Gemini models
├── package.json          # Project metadata and dependencies
├── package-lock.json     # Tracks exact dependency versions
└── README.md             # This file (generated by the tool itself or manually written)

📸 Screenshots

As a command-line interface (CLI) tool, this project does not have graphical user interface screenshots. Below is an example of the typical output when running the index.js script:

AI README Generator (Gemini)

Analyzing code with Gemini...

README.md created successfully

🤝 Contribution Guidelines

Contributions are welcome! If you'd like to contribute to this project, please follow these guidelines:

• Fork the repository: Click the "Fork" button on the top right of this page.
• Clone your forked repository:

  git clone https://github.com/your-username/ai-readme-gen.git
  cd ai-readme-gen
  

• Create a new branch:

  git checkout -b feature/your-feature-name
  

• Make your changes: Implement your features or bug fixes.
• Commit your changes: Write clear and concise commit messages.

  git commit -m "feat: Add new awesome feature"
  

• Push to your branch:

  git push origin feature/your-feature-name
  

• Open a Pull Request: Go to your forked repository on GitHub and click "New pull request". Provide a detailed description of your changes.

📝 License

This project is licensed under the ISC License. See the LICENSE file for more details.