@frigade/react/README.md

Build better product onboarding, faster.

[![npm version](https://img.shields.io/npm/v/@frigade/react)](https://www.npmjs.com/package/@frigade/react)
[![npm downloads](https://img.shields.io/npm/dw/@frigade/react)](https://www.npmjs.com/package/@frigade/react)
[![npm version](https://github.com/FrigadeHQ/javascript/actions/workflows/tests.yml/badge.svg)](https://github.com/FrigadeHQ/javascript/actions/workflows/tests.yml)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

<H3 align="center"><strong>Frigade React SDK</strong></H3>
<div align="center">The easiest way for developers to build high-quality product onboarding and education.</div>
<br />
<div align="center">
<a href="https://frigade.com">Website</a> 
<span> · </span>
<a href="https://demo.frigade.com">Demo</a> 
<span> · </span>
<a href="https://github.com/FrigadeHQ">GitHub</a> 
<span> · </span>
<a href="https://docs.frigade.com/v2/sdk/quickstart">Docs</a></div>

<br />

![Frigade image](https://cdn.frigade.com/0534ad31-8dc3-4061-9e53-53aae2ff3cf8.png)

## Install

Install the package from your command line.

#### With yarn

```bash
yarn add @frigade/react
```

#### With npm

```bash
npm install @frigade/react
```

#### With pnpm

```bash
pnpm install @frigade/react
```

### About Frigade
[Frigade](<https://frigade.com>) is a developer-first platform for building quality product onboarding. A powerful, flexible API and native SDKs allow you to build onboarding 10x faster, experiment more easily, and drive customer success.

Frigade supports a series of use cases such as:

- **Registration**: Maximize the number of users getting through your sign up flows with beautiful explainers, progress bars, and forms.
- **Activation**: Convert more customers by taking them through a series of key onboarding items specific to their role, permissions, or goals.
- **Adoption**: Introduce audiences to specific features that deliver value with native hotspots, tooltips, tours, and interactive product guides.
- **Engagement**: Keep active customers engaged, announce new product features, and create lifecycle specific re-onboarding flows for dormant or churned customers.
- **Retention**: Increase retention by delivering the right content at the right time, and by asking your users for feedback on the product.


# Features

**Component Library**

Unstyled, ready-made components for building high‑quality user onboarding, faster. Onboarding checklists, tooltips, product walkthroughs, and much more. [See components](https://frigade.com/components)

**Integrations**

Integrations with Segment, Mixpanel, Posthog, and more to power targeting, analytics, and communications.

**Content Management**

Lightweight CMS built-in to update and test onboarding copy and content.

**Versioning**

Frigade makes it easy to manage multiple versions of onboarding across staging and production. Revisit previous versions of onboarding to see how they performed and make improvements.

**Customer Journeys**

Frigade automatically tracks state management and onboarding progress. Give your team full observability into the customer journey, and use Frigade to kick off automated workflows.


To learn more, visit [frigade.com](<https://frigade.com>)