# Project Name

> Adapted from the structure of
> [Best-README-Template](https://github.com/othneildrew/Best-README-Template)
> (Unlicense) – the most-starred README template on GitHub. Heavyweight
> variant; use `readme.md` for something leaner.

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![License][license-shield]][license-url]

<br />
<div align="center">
  <h3>Project Title</h3>
  <p>
    One-paragraph project description – what it is, who it is for,
    why it exists.
    <br />
    <a href="https://docs.example.com"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://demo.example.com">View Demo</a>
    ·
    <a href="https://github.com/you/repo/issues">Report Bug</a>
    ·
    <a href="https://github.com/you/repo/issues">Request Feature</a>
  </p>
</div>

## Table of contents

- [About the project](#about-the-project)
  - [Built with](#built-with)
- [Getting started](#getting-started)
  - [Prerequisites](#prerequisites)
  - [Installation](#installation)
- [Usage](#usage)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
- [Acknowledgments](#acknowledgments)

## About the project

Longer description: the problem, the approach, what makes it different.
Screenshots or a short demo GIF go here.

### Built with

- [Next.js](https://nextjs.org)
- [React](https://react.dev)
- [TypeScript](https://www.typescriptlang.org)

## Getting started

How to get a local copy running.

### Prerequisites

```bash
node --version   # >= 20 LTS
pnpm --version   # >= 9
```

### Installation

1. Clone the repo

```bash
git clone https://github.com/you/repo.git
cd repo
```

2. Install dependencies

```bash
pnpm install
```

3. Configure environment – copy `.env.example` to `.env` and fill in
   values.

4. Run

```bash
pnpm dev
```

## Usage

Real usage examples – the most important section for adoption:

```bash
your-tool build --input file.md --output out/
```

```ts
import {feature} from 'your-package';
const result = await feature.run();
```

More examples in the [documentation](https://docs.example.com).

## Roadmap

- [x] Feature shipped
- [x] Feature shipped
- [ ] Feature in progress
- [ ] Planned feature

See [open issues](https://github.com/you/repo/issues) for the full list.

## Contributing

Contributions make open source work – and are **welcome**.

1. Fork the project
2. Create a branch: `git checkout -b feat/amazing`
3. Commit: `git commit -m 'feat: add amazing thing'`
4. Push and open a PR

See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and gates.

## License

Distributed under the MIT License. See `LICENSE` for details.

## Contact

Your Name – [@handle](https://x.com/handle) – you@example.com

Project link: [https://github.com/you/repo](https://github.com/you/repo)

## Acknowledgments

- [Resource or library credit](https://example.com)
- [Inspiration credit](https://example.com)
- [Template credit](https://github.com/othneildrew/Best-README-Template)

<!-- badge link references -->
[contributors-shield]: https://img.shields.io/github/contributors/you/repo.svg
[contributors-url]: https://github.com/you/repo/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/you/repo.svg
[forks-url]: https://github.com/you/repo/network/members
[stars-shield]: https://img.shields.io/github/stars/you/repo.svg
[stars-url]: https://github.com/you/repo/stargazers
[issues-shield]: https://img.shields.io/github/issues/you/repo.svg
[issues-url]: https://github.com/you/repo/issues
[license-shield]: https://img.shields.io/github/license/you/repo.svg
[license-url]: https://github.com/you/repo/blob/main/LICENSE