README Maker — fill in a form, get a README.md

You put the project up and there is no description, and writing one is the last thing you feel like doing. Fill in the form above and the file writes itself: badges, a table of contents, sections on installation and usage, straight to your clipboard.

It is for anyone pushing a repository that deserves a front page and has a blank one. There is no account, nothing to pay for, and nothing is uploaded — the form, the Markdown and the preview all run inside your browser, and the page makes no network requests once it has loaded.

What ends up in the file

• A title, and any badges you tick
• Your description, followed by a table of contents linking the sections you filled in
• Features as a bullet list, one line per feature
• Installation and Usage as fenced code blocks
• A License section: MIT, Apache 2.0, GPL 3.0, BSD 3-Clause, or none

Sections you leave empty are left out entirely, so the result has no headings with nothing under them.

Badges available

Ten shields.io badges, ticked on and off: Node.js, React, TypeScript, Python, JavaScript, Vue.js, Angular, Docker, Rust and Go.

What it gives you back

A project called lumen with two badges, three features and an MIT licence comes out like this:

# lumen

![Node.js](https://img.shields.io/badge/Node.js-339933?...) ![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?...)

A tiny static-site server with live reload.

## Table of Contents

- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)

## Features

- Zero config
- Live reload over WebSocket
- Single 40 kB binary

## Installation

```bash
npm install -g lumen
```

## Usage

```
lumen ./public --port 8080
```

## License

This project is licensed under the MIT License.

The preview on the right renders that Markdown as you type, so you see the page GitHub will show before you paste anything.

More small tools →

Made by Aleksandr Fedorov at alftech.space. Nothing you type here reaches a server: the form, the Markdown and the preview all run in this tab. If a badge points somewhere wrong, or GitHub renders the file differently from the preview, write to a@alftech.space