userorbit-js/README.md

Userorbit js allows you to connect your application to Userorbit, display announcements, roadmap, collect feedback, show product tours, and more.

# Userorbit Browser JS Library

[![npm package](https://img.shields.io/npm/v/userorbit-js?style=flat-square)](https://www.npmjs.com/package/userorbit-js)
[![MIT License](https://img.shields.io/badge/License-MIT-red.svg?style=flat-square)](https://opensource.org/licenses/MIT)

Please see [Userorbit Docs](https://userorbit.com/help).

## What is Userorbit

Userorbit is an all-in-one customer engagement and product adoption platform designed to streamline feedback management, team collaboration, and customer communication. With Userorbit, businesses can easily capture real-time customer insights through customizable feedback boards, ensuring they stay aligned with user needs.

Key features include an intuitive product roadmap where teams can engage directly with customers and provide progress updates. Once features are shipped, announcements can be seamlessly delivered via in-app widgets, email newsletters, or a dedicated customer portal, boosting customer awareness and engagement. please check out [userorbit.com](https://userorbit.com).

## How to use this library

1. Install the Userorbit package inside your project using npm:

```bash
npm install -s userorbit-js
```

2. Import Userorbit and initialize the widget in your main component (e.g., App.tsx or App.js):

```javascript
import userorbit from "userorbit-js";

if (typeof window !== "undefined") {
  userorbit.init({
    accountId: "ACCOUNT_UUID",
    apiHost: "https://api.userorbit.com",
  });
}
```

For more detailed guides for different frameworks, check out our [Framework Guides](https://userorbit.com/docs/getting-started/framework-guides).