# @retoo/borda

[![npm version](https://img.shields.io/npm/v/@retoo/borda)](https://www.npmjs.com/package/@retoo/borda)
[![bundle size](https://img.shields.io/badge/gzipped-~42KB-blue)](https://use-retoo.github.io/borda/distribution/bundle-size)
[![license](https://img.shields.io/badge/license-PolyForm%20Shield%201.0.0-blue)](./LICENSE.md)

Embeddable onboarding widget for any website. Framework-agnostic, SSR-safe, ~42KB gzipped.

**[Documentation](https://use-retoo.github.io/borda)**

## Installation

```bash
# npm
npm install @retoo/borda

# pnpm
pnpm add @retoo/borda

# yarn
yarn add @retoo/borda

# bun
bun add @retoo/borda
```

**CDN**

```html
<link rel="stylesheet" href="https://unpkg.com/@retoo/borda/dist/borda.min.css" />
<script src="https://unpkg.com/@retoo/borda/dist/borda.min.umd.js"></script>
```

## Browser support

Modern evergreen browsers (Chrome, Firefox, Safari, Edge). Internet Explorer is not supported.

## Contributing

Bug fixes and patches are welcome — open a pull request. For larger changes, open an issue first. See [CONTRIBUTING.MD](./CONTRIBUTING.MD) for details.

## License

[PolyForm Shield 1.0.0](./LICENSE.md) — free to use, modifications and redistribution allowed; competing products not permitted.

Copyright © Retoo — Dmitry Derzhavin — [support@retoo.ru](mailto:support@retoo.ru)