Documentation

Getting started with HoraCHANGELOG

Everything you need to publish release notes, embed the widget, and keep your users informed.

Getting Started

1

Create an account

Go to the register page and sign up with your email. No credit card required.

2

Create a project

From the dashboard, click New project. Give it a name and choose a unique slug — this becomes your public URL (e.g. yourapp.changelogsaas.com/c/your-slug).

3

Publish your first entry

Go to Entries → New entry. Write your release note, pick a tag (Feature / Fix / Improvement), and hit Publish.

4

Share your changelog

Your public changelog is live immediately at /c/your-slug. Share the link or embed the widget in your app.

Embedding the Widget

Add the script tag

Paste the snippet below into your HTML, just before </body>. Replace YOUR_SLUG with your project slug.

<script
  src="https://cdn.changelogsaas.com/widget.js"
  data-slug="YOUR_SLUG"
  defer>
</script>

Add the trigger element

Add a button or link with the data-changelog-trigger attribute anywhere in your UI. The widget opens as a popover.

<button data-changelog-trigger>
  What's new
</button>

Customise appearance (optional)

Override colors using CSS variables on the trigger element's parent.

:root {
  --cl-accent: #f97316;   /* badge / highlight color */
  --cl-radius: 8px;        /* border radius */
}

Writing Entries

Tags

Each entry has one tag: Feature (new functionality), Fix (bug fix), or Improvement (enhancement to existing behaviour). Tags are shown as colored badges on your public page and in the widget.

Rich text editor

The editor supports bold, italic, headings, bullet lists, numbered lists, inline code, and code blocks. You can also paste images directly.

Draft vs Published

Entries saved as Draft are not visible on the public page. Set status to Published when you are ready — subscribers get an email notification automatically.

Subscribers & Notifications

How users subscribe

Visitors on your public changelog page can enter their email in the subscribe form. They receive a confirmation email and are added to your subscriber list after confirming.

Automatic notifications

When you publish an entry, all confirmed subscribers receive an email notification containing the entry title, tag, and a link to your changelog.

Managing subscribers

View all subscribers from the Subscribers tab in the dashboard. You can see their email, subscription date, and confirmation status.

FAQ

Is there a free plan?

Yes. All features are free. There is no paid tier — no subscriber limit, no entry limit.

Can I use a custom domain?

Custom domain support is on the roadmap. For now, your changelog is available at /c/your-slug on our domain.

What happens when I publish an entry?

The entry appears on your public changelog immediately. An email notification is queued and sent to all confirmed subscribers within a few seconds.

Can I delete subscribers?

Subscribers can unsubscribe at any time via the link in each email. You can also view and remove them from the Subscribers page in your dashboard.

Ready to get started?

Create your changelog in under 5 minutes — free, no credit card needed.

Create your changelog
HoraCHANGELOG