Badges Overview - Introduction to ChangeCrab Badges

Learn about ChangeCrab badges, what they are, and how they help showcase your changelog activity to visitors.

All Articles

Badges Overview - Introduction to ChangeCrab Badges

ChangeCrab badges are dynamic visual indicators that showcase your changelog's update frequency and activity level. Display them on your website, README files, or documentation to let visitors know you're actively maintaining your product.

What Are ChangeCrab Badges?

ChangeCrab badges are small, embeddable widgets that automatically display information about your changelog's activity. They update automatically based on your publishing frequency and help build trust with your users by showing that your product is actively maintained.

Key Features

  • Automatic Updates - Badges update automatically as you publish new changelog entries
  • Multiple Types - Choose from frequency, tier level, or activity indicators
  • Customizable Styles - Multiple style options including flat, plastic, and dark themes
  • Easy Embedding - Simple HTML, Markdown, or JavaScript embed codes
  • Tier-Based Colors - Badge colors automatically reflect your tier level (Bronze, Silver, Gold)

Badge Components

Every ChangeCrab badge consists of two main parts:

  1. Left Side - Contains the ChangeCrab logo and optionally the "ChangeCrab" attribution text
  2. Right Side - Displays your badge information (frequency, tier, or activity status) with a color that matches your tier level

What Information Do Badges Show?

Badges can display three types of information:

  • Update Frequency - Shows how often you update (e.g., "Updated Weekly", "Updated Fortnightly")
  • Tier Level - Displays your current tier (Bronze, Silver, Gold, or Inactive)
  • Activity Status - Simple active/inactive indicator

Learn more about badge types and styles.

Badge Tiers

Your badge's color and displayed information are based on your tier level, which is calculated from your publishing activity:

  • Gold - 7+ distinct weeks with updates in the last 60 days, and updated within the last 10 days
  • Silver - 4+ distinct weeks with updates in the last 60 days, and updated within the last 21 days
  • Bronze - At least 1 update day in the last 60 days
  • Inactive - No updates in the last 61 days

Read our detailed guide on how badge tiers work.

Where Can You Use Badges?

Badges are perfect for:

  • Website homepages and landing pages
  • README files on GitHub and other code repositories
  • Documentation sites
  • Product pages
  • Anywhere you want to showcase your changelog activity

Getting Started

  1. Navigate to your changelog settings
  2. Go to the "Badges" section
  3. Choose your preferred badge type and style
  4. Copy the embed code
  5. Paste it into your website or documentation

Next Steps