# Glintpost Full Documentation

Glintpost is a platform that provides embeddable widgets for changelogs and roadmaps, designed for SaaS companies to communicate product updates and gather user feedback.

## Quickstart Guide

Get up and running with Glintpost in less than 5 minutes by integrating our widgets directly into your HTML or React application.

### 1. Get your API Key
You need a public API Key from your Glintpost dashboard. Navigate to **Settings > API Keys** and copy the provided string.

### 2. Add the Script Tag
Include the specific widget script before the closing `</body>` tag of your HTML:

```html
<script src="https://app.glintpost.com/changelog-widget.js" data-api-key="YOUR_API_KEY_HERE"></script>
```

---

## Changelog Widget

The Changelog widget adds an interactive badge to your website that expands into a chronological feed of product updates.

### Integration Modes

1. **Slide-over Widget (Recommended)**: Adds a floating badge. Clicking it opens a slide-over panel.
```html
<script src="https://app.glintpost.com/changelog-widget.js" data-api-key="YOUR_API_KEY_HERE" defer></script>
```

2. **Inline Embed**: Embed the changelog directly into a complete page using an iframe.
```html
<iframe
  src="https://app.glintpost.com/changelog?apiKey=YOUR_API_KEY_HERE"
  style="width: 100%; height: 600px; border: none; border-radius: 8px;"
></iframe>
```

3. **Hosted Page**: Link directly to a standalone hosted page: `https://app.glintpost.com/changelog?apiKey=YOUR_API_KEY_HERE`

---

## Roadmap Widget

The Roadmap widget enables public feature voting and transparent product planning.

### Integration Modes

1. **Inline Embed (Recommended)**: Embed the roadmap board into a dedicated page.
```html
<iframe
  src="https://app.glintpost.com/board?apiKey=YOUR_API_KEY_HERE"
  style="width: 100%; height: 600px; border: none; border-radius: 8px;"
></iframe>
```

2. **Hosted Page**: Link directly to the hosted roadmap page.

---

## User Tracking

Identify your logged-in users to provide personalized experiences and accurate vote mapping across devices. This prevents duplicate voting on the roadmap.

### Identifying Visitors
Before loading the widget scripts, define the `GlintPostConfig` object on the `window`.

```html
<script>
  window.GlintPostConfig = {
    // Unique identifier for your logged-in user
    visitorId: "user_12345",
    // Optional: Send context datalayer info
    datalayer: {
      plan: "enterprise",
      role: "admin"
    }
  };
</script>
```

---

## Legal
- **Privacy Policy**: https://glintpost.com/privacy
- **Terms of Service**: https://glintpost.com/terms