README.md Generator

Q: Does it create the LICENSE file too?

No. It adds a License section that links to `LICENSE`; add the license text itself to your repository (GitHub can create it for you).

Fill in a short form and get a clean GitHub README.md with badges, installation, usage, features, contributing and license sections, plus a live Markdown preview.

Project name

GitHub repository

owner/repo, used for badges and the git clone command.

One-line tagline

Description

Features

One feature per line.

Installation command

Usage example

Code language of the example

License

Author

Add shields.io badges (needs a repository)Table of contentsContributing section

README.md

# my-project

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## Installation

```bash
npm install
```

## Usage

```bash
npm start
```

## Contributing

Contributions are welcome! Please open an issue first to discuss what you would like to change.

1. Fork the repository
2. Create a feature branch (`git checkout -b feature/my-feature`)
3. Commit your changes (`git commit -m "Add my feature"`)
4. Push the branch (`git push origin feature/my-feature`)
5. Open a pull request

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

Section headings are written in English, the usual convention for open-source READMEs. Your own text is kept as you typed it.

Related Tools

View All

Random Number Generator Lorem Ipsum Generator QR Code Generator UUID Generator Cron Expression Generator File Checksum Verifier API Key Generator Random Token Generator

What is README Generator?

A README is the first file people read in a repository. This tool turns a few fields — project name, description, features, install and usage commands, license and author — into a well-structured README.md with optional shields.io badges, a table of contents and a contributing guide. You can switch between the Markdown source and a rendered Preview.

How to use README Generator

Enter the Project name and, if it is on GitHub, the GitHub repository as owner/repo.
Add a One-line tagline, Description, Features (one per line), Installation command and Usage example.
Choose a License, add the Author, and toggle badges, Table of contents and Contributing section.
Check the Preview, then copy or download README.md.

Example

Input

Project name tiny-cache, tagline "A 1 KB LRU cache", repository acme/tiny-cache, install npm install, license MIT, no badges/TOC/contributing

Output

# tiny-cache

> A 1 KB LRU cache

## Installation

```bash
git clone https://github.com/acme/tiny-cache.git
cd tiny-cache
npm install
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

When to use README Generator

Use it to start a README for a new library, CLI, side project or internal repository in a minute, then refine the text by hand. It produces a sensible skeleton, not documentation: you still need to explain configuration, API details and examples specific to your project.

How README Generator works

The form is assembled into GitHub-flavored Markdown: an H1 with the name, optional badges (license, stars, issues from img.shields.io, linked to the repository), a blockquote tagline, then sections for Features, Installation (with a git clone + cd block when a repository is set), Usage (a fenced code block in the language you choose), Contributing, License and Author. The table of contents links use GitHub's heading anchor rules. The preview is rendered with marked and sanitized with DOMPurify.

Common Use Cases

Bootstrapping the README of a new open-source package
Standardizing README structure across team repositories
Adding license and contributing sections quickly
Creating a README for a portfolio or hackathon project

FAQs

Does it create the LICENSE file too?

No. It adds a License section that links to LICENSE; add the license text itself to your repository (GitHub can create it for you).

Why are the headings in English?

English section headings are the convention for open-source READMEs and make projects easier to scan for contributors worldwide. Your own text stays in whatever language you write it.