<h1 align="center">
    <a style="text-decoration: none" href="https://www.svix.com">
      <img width="120" src="https://diom.svix.com/icon.svg" />
      <p align="center">Diom - by Svix</p>
    </a>
</h1>


Typescript/Javascript library for interacting with the Diom API

![GitHub tag](https://img.shields.io/github/tag/svix/diom.svg)
[![NPM version](https://img.shields.io/npm/v/@diomhq/diom.svg)](https://www.npmjs.com/package/@diomhq/diom)

# Usage Documentation

You can find general usage documentation at <https://diom.svix.com/docs>.

# Installation

```sh
npm install @diomhq/diom
# or
yarn add @diomhq/diom
```

## Usage
Please refer to [the documentation](https://diom.svix.com) for more usage instructions.

# Development

First checkout the [core README](../../README.md#developing) for details on how to generate our API bindings, then follow the steps below.

## Requirements

 - node
 - npm

## Building the library
```sh
npm install
npm run build
```

## Contributing

Before opening a PR be sure to format your code!

```sh
npm run lint:fix
```

## Running Tests

Simply run:

```sh
npm test
```
