README Generator

Create a README.md template with installation, usage, API, contributing, and license sections.

freeworks offlinenothing uploaded
Input
Output

About readme generator

README Generator needs nothing from a server once the page has loaded. Leave it open on a train with no signal and it carries on.

Nothing here is stored between visits. Reload the page and you start from an empty box again.

You will find it under Markdown, alongside 30 other tools for the same sort of job.

Auto-generates import statements and npm install commands from your project name.

How to use it

01
Start it
Every control is on the tool itself. Keyboard shortcuts, where there are any, are listed beside it.
02
Watch it run
It updates in the page as you go. Nothing is sent anywhere, so it keeps working with the network off.
03
Close when done
Nothing is stored between visits. Reloading gives you a clean start rather than picking up where you left off.

Examples

Generate a project README
Create a README.md from project details
Input
projectName: my-api
description: A fast REST API framework
features: ["Automatic routing","Middleware support"]
Output
# my-api

A fast REST API framework

## Features

- Automatic routing
- Middleware support

## Installation

```bash
npm install my-api
```

## Usage

```javascript
import { myapi } from 'my-api';

// Your code here
```

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

## License

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

Questions

Does README Generator work offline?+

Yes. It is JavaScript running in this tab, so once the page has loaded it needs nothing further from the network. Put the machine in flight mode and it carries on. Nothing you do here is sent anywhere, because there is nowhere for it to go.

Does it remember anything between visits?+

No. Reload the page and it starts from nothing. There is no account, no saved state and no cookie holding your last session. That is a deliberate trade: it cannot lose your data because it never keeps any.

Is it accurate?+

Timing comes from performance.now(), the high resolution clock the browser provides, rather than from setInterval, which drifts by a few milliseconds every tick and compounds over minutes. What can still shift things is the browser throttling a tab in the background, so leave it visible if the timing matters.

Does it make a sound?+

Where a sound makes sense, it is generated with the Web Audio API rather than loaded as a file, so there is nothing to download and nothing to block. Browsers refuse to start audio until you have interacted with the page, which is why the first press is what switches it on.

Can I use README Generator on a phone?+

Yes. The controls are sized for touch and the layout collapses to one column on a narrow screen. Bear in mind that a phone locking its screen will suspend the page, and timing stops with it.