{"id":13815549,"url":"https://github.com/HazAT/badge","last_synced_at":"2025-05-15T09:32:24.013Z","repository":{"id":38419299,"uuid":"45565876","full_name":"HazAT/badge","owner":"HazAT","description":"Add a badge to your app icon","archived":false,"fork":false,"pushed_at":"2024-01-18T14:07:25.000Z","size":756,"stargazers_count":968,"open_issues_count":13,"forks_count":88,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-05-11T09:18:26.390Z","etag":null,"topics":["app-icon-generator","badge","fastlane","icons"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HazAT.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-11-04T20:36:40.000Z","updated_at":"2025-03-29T18:23:01.000Z","dependencies_parsed_at":"2024-05-28T13:50:41.756Z","dependency_job_id":null,"html_url":"https://github.com/HazAT/badge","commit_stats":{"total_commits":102,"total_committers":24,"mean_commits":4.25,"dds":"0.43137254901960786","last_synced_commit":"a8a6c8ca95d005590cb4decd6393160b08043289"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HazAT%2Fbadge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HazAT%2Fbadge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HazAT%2Fbadge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HazAT%2Fbadge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HazAT","download_url":"https://codeload.github.com/HazAT/badge/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254149949,"owners_count":22022851,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["app-icon-generator","badge","fastlane","icons"],"created_at":"2024-08-04T04:03:34.964Z","updated_at":"2025-05-15T09:32:23.988Z","avatar_url":"https://github.com/HazAT.png","language":"Ruby","funding_links":[],"categories":["Happy Exploring 🤘","Ruby"],"sub_categories":[],"readme":"badge - add a badge to your tvOS/iOS/Android app icon\n============\n\n[![Twitter: @DanielGri](https://img.shields.io/badge/contact-@DanielGri-blue.svg?style=flat)](https://twitter.com/DanielGri)\n[![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/HazAT/badge/blob/master/LICENSE)\n[![Gem](https://img.shields.io/gem/v/badge.svg?style=flat)](http://rubygems.org/gems/badge)\n[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-badge)\n\n# Features\n\nThis gem helps to add a badge to your tvOS/iOS/Android app icon.\n\nYes that's it.\nIt's built to easily integrate with [fastlane](https://github.com/fastlane/fastlane).\n\n![assets/icon175x175.png](assets/icon175x175.png?raw=1) ![assets/icon175x175_fitrack.png](assets/icon175x175_fitrack.png?raw=1)\n---\n```\nbadge\n```\n\n![assets/icon175x175_light_badged.png](assets/icon175x175_light_badged.png?raw=1) ![assets/icon175x175_fitrack_light_badged.png](assets/icon175x175_fitrack_light_badged.png?raw=1)\n---\n```\nbadge --dark\n```\n\n![assets/icon175x175_dark_badged.png](assets/icon175x175_dark_badged.png?raw=1) ![assets/icon175x175_fitrack_dark_badged.png](assets/icon175x175_fitrack_dark_badged.png?raw=1)\n---\n```\nbadge --alpha\n```\n\n![assets/icon175x175_alpha_light_badged.png](assets/icon175x175_alpha_light_badged.png?raw=1) ![assets/icon175x175_fitrack_alpha_light_badged.png](assets/icon175x175_fitrack_alpha_light_badged.png?raw=1)\n---\n```\nbadge --shield \"1.2-2031-orange\" --no_badge\n```\n\n![assets/icon175x175_shield_1.2-2031-orange.png](assets/icon175x175_shield_1.2-2031-orange.png?raw=1) ![assets/icon175x175_fitrack_shield_1.2-2031-orange.png](assets/icon175x175_fitrack_shield_1.2-2031-orange.png?raw=1)\n---\n```\nbadge --shield \"1.2-2031-orange\" --no_badge --shield_no_resize\n```\n\n![assets/icon175x175_shield_1.2-2031-orange-no-resize.png](assets/icon175x175_shield_1.2-2031-orange-no-resize.png?raw=1) ![assets/icon175x175_fitrack_shield_1.2-2031-orange-no-resize.png](assets/icon175x175_fitrack_shield_1.2-2031-orange-no-resize.png?raw=1)\n---\n```\nbadge --shield \"Version-0.0.3-blue\" --dark\n```\n\n![assets/icon175x175_shield_Version-0.0.3-blue.png](assets/icon175x175_shield_Version-0.0.3-blue.png?raw=1) ![assets/icon175x175_fitrack_shield_Version-0.0.3-blue.png](assets/icon175x175_fitrack_shield_Version-0.0.3-blue.png?raw=1)\n---\n```\nbadge --shield \"Version-0.0.3-blue\" --dark --shield_geometry \"+0+25%\" --shield_scale 0.75\n```\n\n![assets/icon175x175_shield_Version-0.0.3-blue-geo-scale.png](assets/icon175x175_shield_Version-0.0.3-blue-geo-scale.png?raw=1) ![assets/icon175x175_fitrack_shield_Version-0.0.3-blue-geo-scale.png](assets/icon175x175_fitrack_shield_Version-0.0.3-blue-geo-scale.png?raw=1)\n---\n```\nbadge --grayscale --shield \"Version-0.0.3-blue\" --dark\n```\n\n![assets/icon175x175_grayscale.png](assets/icon175x175_grayscale.png?raw=1) ![assets/icon175x175_fitrack_grayscale.png](assets/icon175x175_fitrack_grayscale.png?raw=1)\n---\n\n# Installation\n\nInstall the gem\n\n    sudo gem install badge\n\n\n# Usage\n\nCall ```badge``` in your projects root folder\n\n    badge\n\nIt will search all subfolders for your asset catalog app icon set and add the badge to the icons.\n\nYou can also run badge on your Android, tvOS icons, or any other iconset.\nYou have to use the `--glob \"/**/*.appiconset/*.{png,PNG}\"` parameter to adjust where to find your icons.\n\n:warning: Note that you have to use a `/` in the beginning of the custom path, even if you're not starting from the root path, f.ex. if your icons are in `res/ios/beta/Appicon/*`, your badge call would be `badge --glob \"/res/ios/beta/Appicon/*\"`\n\nThe keep the alpha channel in the icons use `--alpha_channel`\n\n*Be careful, it actually overwrites the icon files.*\n\nHere is the dark option (also available in combination with ```--alpha```):\n\n\tbadge --dark\n\nYou can also use your custom overlay/badge image\n\n    badge --custom \"path_to/custom_badge.png\"\n\nAdd a shield at the top of your icon for all possibilites head over to: [shields.io](http://shields.io/). You just have to add the string of shield (copied from the URL)\n\n    badge --shield \"Version-0.0.3-blue\"\n    \nSometimes the response from shields.io takes a long time and can timeout. You can adjust the timeout to shields.io with `--shield_io_timeout 10` accordingly.\n\n`--shield_gravity North` changes the postion of the shield on the icon. Choices include: NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast.\n\n`--shield_parameters \"colorA=abcdef\u0026style=flat\"` changes the parameters of the shield image. It uses a string of key-value pairs separated by ampersand as specified on shields.io, eg: colorA=abcdef\u0026style=flat.\n\nIn version [0.4.0](https://github.com/HazAT/badge/releases/tag/0.4.0) the default behavior of the shield graphic has been changed. The shield graphic will always be resized to **aspect fill** the icon instead of just adding the shield on the icon. To disable the new behaviour use `--shield_no_resize` which now only puts the shield on the icon again.\n\nAdd ```--no_badge``` as an option to hide the beta badge completely if you just want to add a shield.\n\nUse `badge --help` to get list all possible parameters.\n\n# Usage with fastlane\n\nPlease use the fastlane plugin: https://github.com/HazAT/fastlane-plugin-badge\nIt has the same parameters as this gem.\n\n```ruby\nlane :appstore do\n  increment_build_number\n  cocoapods\n\n  add_badge(dark: true) #or\n  #add_badge(alpha: true) #or\n  #add_badge(custom: \"/Users/HazA/Desktop/badge.png\") #or\n  #add_badge(shield: \"Version-0.0.3-blue\", no_badge: true)\n\n  xctool\n  snapshot\n  sigh\n  deliver\n  sh \"./customScript.sh\"\n\n  slack\nend\n```\n\n# Common problems\n\nIf Jenkins has problems finding imagemagick on your mac add following env variable to your job:\n\n\tPATH=$PATH:/usr/local/bin\n\nMake sure you have imagemagick installed on your machine e.g. for Mac its:\n\n\tbrew install imagemagick\n\n## Uninstall\n\n\tsudo gem uninstall badge\n\n# Thanks\n[@ThomasMirnig](https://twitter.com/ThomasMirnig) [@KrauseFx](https://twitter.com/KrauseFx) [fastlane](https://github.com/fastlane/fastlane)\n\n# License\nThis project is licensed under the terms of the MIT license. See the LICENSE file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHazAT%2Fbadge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FHazAT%2Fbadge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHazAT%2Fbadge/lists"}