Branding & Style Guide

This page defines the official naming and style conventions for the
LightningPiggy open-source project and its mascot.

Mascot Name

LightningPiggy is the canonical name of the piggy-bank character.

LightningPiggy (no space, CamelCase) is the official, canonical form.
Lightning Piggy (with a space) may be used in natural-language prose where readability is preferred.

Usage Guidelines

Use LightningPiggy (no space) for:

Project and repository references
Code (classes, functions, variables, filenames)
Usernames, handles, and hashtags
Asset names (SVG, PNG, GIF, animations)
Firmware, releases, APIs, and technical documentation

Examples

LightningPiggy firmware v2.1
class LightningPiggy
#LightningPiggy
lightningpiggy-logo.svg

Use Lightning Piggy (with a space) for:

Website and marketing copy
Blog posts and articles
Human-friendly documentation
Storytelling and descriptive text

Examples

“Lightning Piggy helps kids save sats.”
“Meet Lightning Piggy, the Bitcoin piggy bank.”

Capitalisation

Always capitalise both words:
- LightningPiggy
- Lightning Piggy
Do not use:
- lightningpiggy
- Lightningpiggy
- LIGHTNING PIGGY

Consistency Guidelines

Do not mix both forms within the same sentence.
In long-form documents, the first mention may use:
LightningPiggy (Lightning Piggy)
After first mention, choose one form and remain consistent.
Avoid common typos such as LightingPiggy ❌

Rationale

Using LightningPiggy as the canonical name provides a strong, unique,
brandable identity suitable for open-source software, code, and community use.

Using Lightning Piggy in prose improves readability and accessibility for
non-technical audiences.

This approach follows established conventions used by other open-source mascot
projects.