badge - add a badge to your iOS/Android app icon

Features

This gem helps to add a badge to your iOS/Android app icon.

Yes that's it. It's built to easily integrate with fastlane.

badge

badge --dark

badge --alpha

badge --shield="1.2-2031-orange" --no_badge

badge --shield="Version-0.0.3-blue" --dark

Installation

Install the gem

sudo gem install badge

Usage

Call badge in your iOS projects root folder

badge

It will search all subfolders for your asset catalog app icon set and add the badge to the icons.

But you can also run badge on your Android icons. You have to use the --glob="/**/*.appiconset/*.{png,PNG}" parameter to adjust where to find your icons.

The keep the alpha channel in the icons use --alpha_channel

Be careful, it actually overwrites the icon files.

Here is the dark option (also available in combination with --alpha):

badge --dark

You can also use your custom overlay/badge image

badge --custom="path_to/custom_badge.png"

Add a shield at the top of your icon for all possibilites head over to: shields.io. You just have to add the string of shield (copied from the URL)

badge --shield="Version-0.0.3-blue"

Sometimes the response from shield.io takes a long time and can timeout. You can adjust the timeout to shield.io with --shield_io_timeout=10 accordingly.

Add --no_badge as an option to hide the beta badge completely if you just want to add a shield.

Usage with fastlane

lane :appstore do
  increment_build_number
  cocoapods

  badge(dark: true) #or
  #badge(alpha: true) #or
  #badge(custom: "/Users/HazA/Desktop/badge.png") #or
  #badge(shield: "Version-0.0.3-blue", no_badge: true)

  xctool
  snapshot
  sigh
  deliver
  sh "./customScript.sh"

  slack
end

If Jenkins has problems finding imagemagick on your mac add following env variable to your job:

PATH=$PATH:/usr/local/bin

Uninstall

sudo gem uninstall badge

Thanks

@ThomasMirnig @KrauseFx fastlane

License

This project is licensed under the terms of the MIT license. See the LICENSE file.