Tired of Writing READMEs? Let AI Do It For You.

Transform your repositories with professional, high-quality documentation. Our AI analyzes your code to generate beautiful, attention-grabbing READMEs in seconds.

Why Choose ReadmeGenius?

We believe that great projects deserve great documentation. ReadmeGenius was built by developers, for developers, to eliminate the tedious task of writing READMEs from scratch.

Intelligent Analysis

Our AI scans your repository to understand its structure, dependencies, and purpose, suggesting relevant sections and content.

Customizable Templates

Choose from a variety of professional templates and easily customize them to match your project's unique style and requirements.

Markdown Editor

Fine-tune your README with our intuitive, real-time Markdown editor, ensuring your final document is pixel-perfect.

Get in Touch

Have a question or feedback? We'd love to hear from you.

How It Works

Follow these simple steps to generate your professional README file in seconds.

Step 1: Sign In with GitHub

To begin, you need to sign in using your GitHub account. This is required so our tool can identify you and later create a Pull Request on your behalf. Click the "Sign in with GitHub" button in the navigation bar.

Step 2: Provide Repository Details

After signing in, click the "Connect Repository & Generate" button. A pop-up will appear asking for two things:

GitHub Repository URL: The full URL of the public or private repository for which you want to generate a README.
GitHub Personal Access Token: This is a secure token that gives our workflow temporary permission to access your repository.

Step 3: How to Generate a GitHub Token

The Personal Access Token is crucial for the process. It allows our tool to analyze your code and create a new branch with the generated README. Your token is not stored and is used only for this one-time operation.

Go to the New personal access token page on GitHub.
Give your token a descriptive name (e.g., "ReadmeGeniusToken").
Set an expiration date for the token for security.
Under "Repository access", select the repositories you want to give access to.
Under "Permissions", click on "Repository permissions" and ensure that the **"Contents"** permission is set to **"Read and write"**. This is necessary to create a branch and commit the new README file.
Click **"Generate token"**.
**Important:** Copy the generated token immediately. GitHub will not show it to you again. Paste this token into the modal on our website.

Step 4: Generate and Review

Once you provide the URL and token, click "Generate". Our AI will analyze your repository, create the README, and then open a new Pull Request in your repository from a branch named `readme-update-[timestamp]`. Simply go to your repository, review the Pull Request, and merge it to make your new README live!