Skip to main content
Publish an update once in Maker’s HQ and show it inside your app. Use the MIT-licensed @makershq/react@0.3.1 package. Its anonymous API origin is makershq.dev; no API key, account sign-in or Convex client is required. Open your project’s Release notes → Add to app page for its public project ID. Choose a guide:
  • React: install the reader and scoped stylesheet in a React 19 app.
  • Tauri: mount native windows and Settings with an app-owned updater in a React 19/Tauri 2 app.
  • HTTP API: fetch the wire contract from any client and provide your own rendering.

​
Prepare a release

Write your note and optionally enter an App version, such as 1.2.3. Use a complete semantic version; prerelease and build suffixes such as 1.2.3-beta.1+desktop.7 are preserved. Each project can have one published note per exact version. Drafts can share a version. Unpublishing or deleting a note frees that version for another publication. Leave the version blank for a general update. Unversioned notes remain in the full history. Changing content or its app version restores Draft; choose Publish when it is ready. Version numbers select release notes; your app’s updater decides which software update a customer can install.

​
React

The React guide covers props, exact versions, themes, Markdown, loading, errors and saved copies.

​
Tauri 2

The Tauri guide contains complete installation, root wiring, Settings and updater setup.

​
Consumer-owned updater

The typed updater contract and complete adapter keep persistence, native update handles, installation and relaunch in your app.

​
Existing secondary settings window

Use the secondary Settings setup when main stays hidden and an existing window owns the Settings UI.

​
Native capabilities

Copy the exact local capabilities for main, SDK children and optional existing Settings windows.

​
Verification before release

Verify your own published project, exact native version and offline recovery. Before shipping a desktop binary, complete signed installer/relaunch acceptance for each supported OS. See the Tauri release checks; SDK fixture CI is separate from consumer installer acceptance.

​
Anonymous HTTP API

The HTTP API guide covers full response fields, publication-order pagination, exact versions, errors, CORS and managed images.

​
Custom UI

SDK 0.3.0 adds useReleaseNotesReader, useWebsiteUpdates, ReleaseMarkdown, releaseImageUrl, reader render/link callbacks and opt-in ReleaseNotesHost presentation="headless". Use them to match your app’s existing UI, or keep the supplied reader, website notifications and native-window presentation. The hooks share the existing cache, publication, save-before-refresh and acknowledgment owners. In headless Tauri mode your app controls settings, layout, windows and focus while the main host retains the unchanged app-owned updater and shared preferences. Independent reader/update descriptors expose callbacks bound to their active requests; no request IDs or updater handles become public. See custom React UI and headless Tauri UI for API details and examples.