@journyio/web-types/README.md

TypeScript types for our website snippet

# Web types

![npm](https://img.shields.io/npm/v/@journyio/web-types?color=%234d84f5&style=flat-square)
[![npm downloads](https://img.shields.io/npm/dm/@journyio/web-types?style=flat-square)](https://www.npmjs.com/package/@journyio/web-types)

Enables type-safe usage of our website snippet. A full web SDK will be released later this year.

## 💾 Installation

You can use your package manager (`npm` or `yarn`) to install:

```bash
npm install --save @journyio/web-types
```
or
```bash
yarn add @journyio/web-types
```

## 🔌 Getting started

💡 You can find the snippet in the website settings

```ts
import "@journyio/web-types";
```

You can find documentation for the web snippet [here](https://developers.journy.io).

## 🔒 Security

If you discover any security related issues, please email security at journy io instead of using the issue tracker.