README Generator

Generate a formatted README.md with badges, TOC, and live preview

DeveloperFREEYour data never leaves your browser

100% freeNo signupRuns in your browser

Built by WOWHOW Team · 14+ yrs engineering

README Generator is a free, browser-based tool that lets you generate a formatted readme.md with badges, toc, and live preview — with zero signup, zero installation. Your data never leaves your browser. Part of 138+ free developer and business tools at wowhow.cloud, built and maintained by a team with 14+ years of hands-on development experience.

TOOLREADME Generator

Project Info

Project Name *

GitHub Repo (user/repo)

Description *

Tech Stack (comma or newline separated)

Features (one per line)

Installation steps

Usage example

Badges

License

Optional sections

API ReferenceContributing

# My Project

[![Build Status](https://github.com/username/repo/workflows/CI/badge.svg)](https://github.com/username/repo/actions) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Table of Contents

- [Features](#features)
- [Tech Stack](#tech-stack)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## Features

- Feature one
- Feature two
- Feature three

## Tech Stack

- **Node.js**
- **TypeScript**

## Installation

Clone the repository:

```bash
git clone https://github.com/username/repo
cd my-project
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/amazing-feature`)
3. Commit your changes (`git commit -m 'feat: add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## License

[MIT](LICENSE)

About README Generator

A good README is the first impression of every open-source project. This generator takes your project details and outputs a complete, properly structured Markdown file in seconds.

How It Works

A template engine assembles Markdown by interpolating your inputs. Badge URLs are constructed from shields.io endpoints. TOC is generated from active sections.

Who Is This For

A developer generates a complete README for a new open-source project in 3 minutes.

A team standardizes README files across all internal repositories.

How to Use

Fill in project name, GitHub repo path, and description

Add tech stack and feature list

Select badges and choose a license

Download .md or copy to clipboard

Frequently Asked Questions

Yes. Badges use shields.io URLs with your GitHub repo path for live data.

Title, badges, description, TOC, features, tech stack, installation, usage, license. Optional: API Reference, Contributing.

Yes. Both Installation and Usage fields accept raw Markdown including fenced code blocks.

More Free Tools

View all

Developer

JSON Formatter & Validator

Format, validate & diff JSON — runs entirely in browser

Open tool

Developer

Regex Playground

Test regex live — railroad diagrams + plain English explained

Open tool

Developer

Color System Generator

One color in, full design system out

Open tool

Developer

Cron Expression Builder

Build cron jobs visually — no syntax to memorize

Open tool

Need production-ready templates?

Browse premium developer tools, starter kits, and templates — starting at $49. Pay once, use forever.

Browse Products

# My Project [![Build Status](https://github.com/username/repo/workflows/CI/badge.svg)](https://github.com/username/repo/actions) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) ## Table of Contents - [Features](#features) - [Tech Stack](#tech-stack) - [Installation](#installation) - [Usage](#usage) - [Contributing](#contributing) - [License](#license) ## Features - Feature one - Feature two - Feature three ## Tech Stack - **Node.js** - **TypeScript** ## Installation Clone the repository: ```bash git clone https://github.com/username/repo cd my-project 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/amazing-feature`) 3. Commit your changes (`git commit -m 'feat: add amazing feature'`) 4. Push to the branch (`git push origin feature/amazing-feature`) 5. Open a Pull Request ## License [MIT](LICENSE)