# Project name

One sentence that says what this does and who it is for. If a stranger cannot
tell from this line whether to keep reading, rewrite it.

[![Build](https://img.shields.io/badge/build-passing-brightgreen)](https://example.com)
[![Licence](https://img.shields.io/badge/licence-MIT-blue)](LICENSE)

## Install

```bash
npm install project-name
```

## Usage

```ts
import { thing } from "project-name";

thing({ loud: true });
```

## Options

| Option | Type | Default | What it does |
| --- | --- | --- | --- |
| `loud` | boolean | `false` | Prints every step to stdout |
| `retries` | number | `3` | How often to try again before giving up |
| `timeout` | number | `5000` | Milliseconds before a request is abandoned |

## Why not X

A short, fair comparison with the obvious alternative. Being honest here earns
more trust than a feature list does.

## Contributing

Issues and pull requests are welcome. Run `npm test` before opening one.

## Licence

MIT. See [LICENSE](LICENSE).

npm install project-name

import { thing } from "project-name";

thing({ loud: true });