README Generator

Craft a polished README.md fast.

README options
README.md
# My Project

![Build](https://img.shields.io/badge/build-passing-brightgreen.svg) ![License](https://img.shields.io/badge/license-MIT-blue.svg)

A short description of what this project does.

## Installation

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

## Usage

```bash
npm start
```

## Features

- Fast and lightweight
- Easy to configure
- Well documented

## License

This project is licensed under the MIT License.

About this tool

Fill in your project details to generate a clean, conventional README.md with the sections most projects need.

How to use

  1. Enter the project name, description, and install/usage commands.
  2. Toggle the sections you want to include.
  3. Copy the generated Markdown.

Examples

Heading
# My Project

> A short description

Frequently asked questions

Yes. The output is plain Markdown you can paste and refine in your editor.
Contact

Let’s connect

Have a Liferay or Backend project you’d like to talk through? Fill in the form and I’ll get back to you.

Book Calendar