~/ tool
README Generator
A structured README builder for your open-source kit or side project. Markdown out.
READMEDocs
live in your browser
updated 2026-03-02
README.md
# my-project
> A one-line elevator pitch for the project.



A longer paragraph that explains what this project does, who it's for, and why you'd reach for it instead of the alternatives.
## Table of contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Tech stack](#tech-stack)
- [Contributing](#contributing)
- [License](#license)
## Features
- Fast and lightweight
- Zero dependencies
- TypeScript first
- Tree-shakeable
## Installation
```bash
npm install my-project
# or
pnpm add my-project
```
## Usage
```ts
import { thing } from "my-project";
const result = thing({ foo: "bar" });
console.log(result);
```
## Tech stack
TypeScript, Node 20+
## Contributing
PRs welcome. Please open an issue first for anything bigger than a typo fix. Run `npm test` before submitting.
## License
MIT © Your Name
∴ 1064 chars · everything stays in your browser
Got stuck, or want this shipped end-to-end for you? bitroot.club builds custom products for founders. →