Add warning about 1024x1024 icon size requirement in README#41
Open
pulkit-1110 wants to merge 1 commit intoobytes:masterfrom
Open
Add warning about 1024x1024 icon size requirement in README#41pulkit-1110 wants to merge 1 commit intoobytes:masterfrom
pulkit-1110 wants to merge 1 commit intoobytes:masterfrom
Conversation
Author
|
Hi @SihamBen 👋 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🐛 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
ribbontexts 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
README.mdto 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.