README Template for TypeScript Projects

# Project Name

Brief description of what this project does.

## Prerequisites

- Node.js 18+
- npm or yarn

## Installation

```bash
npm install your-package
```

## Usage

```typescript
import { yourFunction } from "your-package";

const result = yourFunction("input");
console.log(result);
```

## Type Exports

This package exports the following types:

```typescript
import type { Config, Options, Result } from "your-package";
```

## Development

```bash
git clone https://github.com/your-username/your-project.git
cd your-project
npm install
npm run dev
```

## Building

```bash
npm run build
```

## Testing

```bash
npm test
```

## Contributing

1. Fork the repository
2. Create a feature branch
3. Ensure TypeScript compiles with `npm run build`
4. Run tests with `npm test`
5. Submit a pull request

## Licence

MIT