Read.ME (https://readme-ai.netlify.app/)

Read.ME is an AI-powered README.md file generator for your projects. Simply input your project details, and boom! You'll receive the best AI-generated README file response, saving you time and effort.

Table of Contents

• Features
• Tech Stack
• Installation
• Usage
• License
• Contributing

Features

• AI-powered README.md file generation based on your input details
• Dark mode toggle
• Attractive hero section

Tech Stack

• Next.js
• Tailwind CSS
• TypeScript
• Gemini API

Installation

To get started, follow these steps:

git clone <repository_url>
cd <repository_directory>
npm install

Create a .env file in the root of your project and add your Gemini API key:

GEMINI_API_KEY=YOUR_GEMINI_API_KEY

Usage

This project allows you to generate README.md files using AI. Once you have the project installed and your Gemini API key configured, run the development server. The user interface will guide you through the process of inputting your project details.

Once you've entered all the necessary information, click the "Generate README" button. The AI will process your input and generate a comprehensive README.md file, which you can then copy and paste into your project. Remember to remove the markdown ``` from the start and bottom after pasting it into your project.

License

None

Contributing

Contributions are welcome.

PS : This Readme file is generated by Read.ME ;)