README Template

# Project Name

> A short, one-line description of what your project does.

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](#license)

## Table of Contents

- [About](#about)
- [Getting Started](#getting-started)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## About

Describe your project in a few paragraphs. Explain the problem it solves, who it is for, and what makes it different from alternatives.

## Getting Started

### Prerequisites

- Node.js >= 18
- pnpm >= 8

### Installation

```bash
git clone https://github.com/your-username/project-name.git
cd project-name
pnpm install
```

## Usage

```bash
pnpm dev
```

Open [http://localhost:3000](http://localhost:3000) in your browser.

### Examples

```typescript
import { myFunction } from "project-name"

const result = myFunction({ input: "hello" })
console.log(result)
```

## Contributing

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

## License

Distributed under the MIT License. See `LICENSE` for more information.