uom-types/README.md

Typesafe units with no runtime overhead.

<div align="center">

# Units of Measure Types

Typesafe units with no runtime overhead.

[![npm version](https://img.shields.io/npm/v/uom-types.svg)](https://www.npmjs.com/package/uom-types)
[![jsr Version](https://img.shields.io/jsr/v/@rebeccastevens/uom-types.svg)](https://jsr.io/@rebeccastevens/uom-types)
[![CI](https://github.com/RebeccaStevens/uom-types/actions/workflows/release.yml/badge.svg)](https://github.com/RebeccaStevens/uom-types/actions/workflows/release.yml)
[![Coverage Status](https://codecov.io/gh/RebeccaStevens/uom-types/branch/main/graph/badge.svg?token=MVpR1oAbIT)](https://codecov.io/gh/RebeccaStevens/uom-types)
[![Documentation](./docs/coverage.svg)](https://RebeccaStevens.github.io/uom-types/)\
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![GitHub Discussions](https://img.shields.io/github/discussions/RebeccaStevens/uom-types?style=flat-square)](https://github.com/RebeccaStevens/uom-types/discussions)
[![BSD 3 Clause license](https://img.shields.io/github/license/RebeccaStevens/uom-types.svg?style=flat-square)](https://opensource.org/licenses/BSD-3-Clause)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](https://commitizen.github.io/cz-cli/)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)

</div>

## Donate

[Any donations would be much appreciated](./DONATIONS.md). 😄

### Enterprise Users

`uom-types` is available as part of the [Tidelift Subscription](https://tidelift.com/funding/github/npm/uom-types).

Tidelift is working with the maintainers of `uom-types` and a growing network of open source maintainers
to ensure your open source software supply chain meets enterprise standards now and into the future.
[Learn more.](https://tidelift.com/subscription/pkg/npm-uom-types?utm_source=npm-uom-types&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)

## Installation

### npm

```sh
# Install with npm
npm install uom-types

# Install with pnpm
pnpm add uom-types

# Install with yarn
yarn add uom-types

# Install with bun
bun add uom-types
```

### jsr

```sh
# Install in a node project
npx jsr add @rebeccastevens/uom-types

# Install in a deno project
deno add jsr:@rebeccastevens/uom-types

# Install in a bun project
bunx jsr add @rebeccastevens/uom-types
```

## Documentation

Check out [RebeccaStevens.github.io/uom-types](https://RebeccaStevens.github.io/uom-types/) for the documentation.

## Inspiration

Inspired by [uom-ts](https://github.com/mindbrave/uom-ts).