README.md.tmpl

> _👷🏽 TODO: This project is made with [publish-ts](https://github.com/trcps/publish-ts), read the docs to learn more._

> _👷🏽 TODO: Read all the sections marked with "👷🏽 TODO", do them, and remove them from this README._

<div align="right">

[![npm package minimized gzipped size](https://img.shields.io/bundlejs/size/{{ tmplr.package_name }}?style=flat-square&label=%20&color=black)](https://bundlejs.com/?q={{ tmplr.package_name }})
[![npm](https://img.shields.io/npm/v/{{ tmplr.package_name }}?color=black&label=&style=flat-square)](https://www.npmjs.com/package/{{ tmplr.package_name }})
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/{{ tmplr.repo_owner }}/{{ tmplr.repo_name }}/coverage.yml?label=&style=flat-square)]({{ tmplr.repo_url }}/actions/workflows/coverage.yml)

</div>

<img src="./logo-dark.svg#gh-dark-mode-only" height="42px"/>
<img src="./logo-light.svg#gh-light-mode-only" height="42px"/>

# {{ tmplr.package_name }}

{{ tmplr.package_description }}

```js
// a nice code example here
// would be pretty nice!

import { {{ tmplr.package_name | camelCase }} } from '{{ tmplr.package_name }}'

console.log({{ tmplr.package_name | camelCase }}().msg)
```

<br>

# Contents

- [Contents](#contents)
- [Installation](#installation)
- [Usage](#usage)
- [Contribution](#contribution)

<br>

# Installation

[Node](https://nodejs.org/en/):

```bash
npm i {{ tmplr.package_name }}
```

Browser / [Deno](https://deno.land):

```js
import { {{ tmplr.package_name | camelCase }} } from 'https://esm.sh/{{ tmplr.package_name }}'
```
> _👷🏽 TODO: add the most important necessary imports from {{ tmplr.package_name }} here._

<br>

# Usage

> _👷🏽 TODO: explain in details what {{ tmplr.package_name }} does._

```js
// perhaps with some nice code examples.

import { {{ tmplr.package_name | camelCase }} } from '{{ tmplr.package_name }}'

console.log({{ tmplr.package_name | camelCase }}().msg)
```

<br>

# Contribution

You need [node](https://nodejs.org/en/), [NPM](https://www.npmjs.com) to start and [git](https://git-scm.com) to start.

```bash
# clone the code
git clone {{ tmplr.clone_url }}
```
```bash
# install stuff
npm i
```

Make sure all checks are successful on your PRs. This includes all tests passing, high code coverage, correct typings and abiding all [the linting rules]({{ tmplr.repo_url }}/blob/main/.eslintrc). The code is typed with [TypeScript](https://www.typescriptlang.org), [Jest](https://jestjs.io) is used for testing and coverage reports, [ESLint](https://eslint.org) and [TypeScript ESLint](https://typescript-eslint.io) are used for linting. Subsequently, IDE integrations for TypeScript and ESLint would make your life much easier (for example, [VSCode](https://code.visualstudio.com) supports TypeScript out of the box and has [this nice ESLint plugin](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)), but you could also use the following commands:

```bash
# run tests
npm test
```
```bash
# check code coverage
npm run coverage
```
```bash
# run linter
npm run lint
```
```bash
# run type checker
npm run typecheck
```