README Generator

Generate a complete README.md by filling in your project name, description, install command, usage example, features, and license, with optional shields.io badges.

Written by code.liveHow we review content

Project name

One-line description

Package manager

Package namenpm install

Usage example

Features

License

Include shields.io badges

README.mdmarkdown

# my-project

![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg) ![npm version](https://img.shields.io/npm/v/my-project.svg)

A short description of what this project does.

## Installation

```bash
npm install my-project
```

## Usage

```
import { thing } from "my-project";

thing.doStuff();
```

## Features

- Zero-config setup
- Fully typed API
- Works in the browser and Node.js

## License

This project is licensed under the MIT license.

Back to Tools