Skip to content

Conversation

@pulkit-1110
Copy link

🐛 Fix: Add Image Size Requirement in README

Problem

When using this library with an app icon that is not 1024x1024, the generated badge may not render correctly—especially for long ribbon texts where only a few characters are visible. This is due to scaling issues in the rendering logic.

Solution

Update the documentation to clearly mention that the input icon must be 1024x1024 for the badge to render properly. This prevents confusion and ensures the plugin works as intended.

Changes Made

  • Updated README.md to include a clear note about using 1024x1024 icons.

Motivation

This change helps users avoid broken or unreadable badges, especially in production build pipelines or CI/CD workflows where consistency and visibility are important.

@pulkit-1110
Copy link
Author

Hi @SihamBen 👋
I noticed the README didn't mention the required icon resolution, so I added a note about using a 1024x1024 image to avoid badge clipping.
Let me know if any changes are needed. Would love your feedback on this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant