Skip to content

📚 Expand README usage examples with a copy-paste cookbook#25

Merged
gepser merged 1 commit intomasterfrom
feature/readme-usage-cookbook
Feb 23, 2026
Merged

📚 Expand README usage examples with a copy-paste cookbook#25
gepser merged 1 commit intomasterfrom
feature/readme-usage-cookbook

Conversation

@gepser
Copy link
Owner

@gepser gepser commented Feb 23, 2026

✨ What changed

  • Reworked README examples into a usage cookbook section.
  • Added a top [!TIP] and per-example [!NOTE] panels.
  • Each example now includes:
    • rendered preview
    • direct URL
    • ready-to-paste GitHub Markdown snippet

✅ Cases documented

  1. Integer percentage
  2. Float percentage
  3. Clamping values greater than 100
  4. Clamping values lower than 0
  5. Custom threshold colors (dangerColor, warningColor, successColor)
  6. Fixed bar color (barColor)
  7. Data-bar mode with min + max + label + barColor
  8. Data-bar mode with default label
  9. Custom text label in percentage mode

🧪 Validation

  • mise exec -- make check

📌 Why

The README now shows all practical usage patterns in one place, with copy/paste snippets for GitHub issues/PRs/docs.

@gepser gepser merged commit 710be4a into master Feb 23, 2026
2 checks passed
@gepser gepser deleted the feature/readme-usage-cookbook branch February 23, 2026 00:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant