Documentation

Install once. Keep every release easy to find.

Start with the recommended npm package or the direct CDN loader, then use the API reference when your app needs custom behavior. Every page maps to the public Releaseo runtime.

View @releaseo/sdk on npm Install the SDK →

First integration

A simple path through the docs

Most teams only need the first step. The next two are there when you are ready.

  1. Install @releaseo/sdk

    Install one package and initialize it with your publish key. The compatible runtime loads automatically.

  2. Identify signed-in visitors

    Pass the viewer’s stable id and safe traits after your own app signs them in.

  3. Announce a release in-app

    Choose a banner, toast, or modal in Releaseo — no new UI component to mount.

Need a method? Open the complete SDK API reference →

Start here

Pick an integration path and install the SDK.

Start Installation

Recommended npm setup, direct CDN, framework adapters, and hosted defaults.

 Start CDN quick start

Two script tags, no build step. A real, copy-paste walkthrough: full page, identify users, wire your own buttons, async loading.

Packages

Runtime APIs and framework adapters.

Recommended @releaseo/sdk

Typed npm facade with automatic compatible runtime delivery from the Releaseo CDN.

 Package @releaseo/react

Headless React provider, hooks, unread state, widget actions, and SSR notes.

 Package @releaseo/vue

Headless Vue plugin, composables, unread state, widget actions, and Nuxt notes.

 Advanced @releaseo/sdk-core

Direct, version-pinned host runtime for applications that require a fixed bundled version.

Reference

The complete runtime API, function by function.

Reference SDK API reference

Every window.releaseo function — signatures, parameters, returns, and examples for lifecycle, identity, widget controls, analytics, consent, host actions, and events.

Product

In-app announcements, widget surfaces, backend contract, and integrations.

Launches In-app Launches

Show a banner, toast, or modal on the host page. Learn the right surface, triggers, and delivery rules.

 Widget Widget surfaces

Feature requests, roadmap data, public behavior, tabs, and Home Hub settings.

 Monitor Monitor

Observe a business process like checkout or signup. Your backend reports each step; Releaseo shows a live funnel and alerts Slack or Discord on failure or completion.

 API Backend contract

Public SDK endpoints, dashboard ownership, and visibility rules.

 Integrations GitHub, Slack, Discord, and event routing

Sync releases, issues, and roadmap work with GitHub; broadcast updates, forward analytics, and deliver signed webhooks.

Guides

Long-form walkthroughs and platform context.

Guide Platform overview

Markdown overview of the Releaseo release communication shape.

 Guide SDK widget

MDX overview of the Releaseo widget and installation story.