Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/HazAT/badge
Add a badge to your app icon
https://github.com/HazAT/badge
app-icon-generator badge fastlane icons
Last synced: about 1 month ago
JSON representation
Add a badge to your app icon
- Host: GitHub
- URL: https://github.com/HazAT/badge
- Owner: HazAT
- License: mit
- Created: 2015-11-04T20:36:40.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-01-18T14:07:25.000Z (12 months ago)
- Last Synced: 2024-11-11T19:40:12.399Z (about 2 months ago)
- Topics: app-icon-generator, badge, fastlane, icons
- Language: Ruby
- Homepage:
- Size: 738 KB
- Stars: 966
- Watchers: 12
- Forks: 87
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- Open-Source-Ruby-and-Rails-Apps - badge - add a badge to your tvOS/iOS/Android app icon 🔥 🚀 (Happy Exploring 🤘)
README
badge - add a badge to your tvOS/iOS/Android app icon
============
[](https://twitter.com/DanielGri)
[](https://github.com/HazAT/badge/blob/master/LICENSE)
[](http://rubygems.org/gems/badge)
[](https://rubygems.org/gems/fastlane-plugin-badge)
# Features
This gem helps to add a badge to your tvOS/iOS/Android app icon.
Yes that's it.
It's built to easily integrate with [fastlane](https://github.com/fastlane/fastlane).
 
---
```
badge
```
 
---
```
badge --dark
```
 
---
```
badge --alpha
```
 
---
```
badge --shield "1.2-2031-orange" --no_badge
```
 
---
```
badge --shield "1.2-2031-orange" --no_badge --shield_no_resize
```
 
---
```
badge --shield "Version-0.0.3-blue" --dark
```
 
---
```
badge --shield "Version-0.0.3-blue" --dark --shield_geometry "+0+25%" --shield_scale 0.75
```
 
---
```
badge --grayscale --shield "Version-0.0.3-blue" --dark
```
 
---
# Installation
Install the gem
sudo gem install badge
# Usage
Call ```badge``` in your projects root folder
badge
It will search all subfolders for your asset catalog app icon set and add the badge to the icons.
You can also run badge on your Android, tvOS icons, or any other iconset.
You have to use the `--glob "/**/*.appiconset/*.{png,PNG}"` parameter to adjust where to find your icons.
: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/*"`
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](http://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 shields.io takes a long time and can timeout. You can adjust the timeout to shields.io with `--shield_io_timeout 10` accordingly.
`--shield_gravity North` changes the postion of the shield on the icon. Choices include: NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast.
`--shield_parameters "colorA=abcdef&style=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&style=flat.
In 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.
Add ```--no_badge``` as an option to hide the beta badge completely if you just want to add a shield.
Use `badge --help` to get list all possible parameters.
# Usage with fastlane
Please use the fastlane plugin: https://github.com/HazAT/fastlane-plugin-badge
It has the same parameters as this gem.
```ruby
lane :appstore do
increment_build_number
cocoapods
add_badge(dark: true) #or
#add_badge(alpha: true) #or
#add_badge(custom: "/Users/HazA/Desktop/badge.png") #or
#add_badge(shield: "Version-0.0.3-blue", no_badge: true)
xctool
snapshot
sigh
deliver
sh "./customScript.sh"
slack
end
```
# Common problems
If Jenkins has problems finding imagemagick on your mac add following env variable to your job:
PATH=$PATH:/usr/local/bin
Make sure you have imagemagick installed on your machine e.g. for Mac its:
brew install imagemagick
## Uninstall
sudo gem uninstall badge
# Thanks
[@ThomasMirnig](https://twitter.com/ThomasMirnig) [@KrauseFx](https://twitter.com/KrauseFx) [fastlane](https://github.com/fastlane/fastlane)
# License
This project is licensed under the terms of the MIT license. See the LICENSE file.