https://github.com/ebelair/icon-banner
🚩 IconBanner adds custom nice-looking banners over your mobile app icons 📱
https://github.com/ebelair/icon-banner
banners fastlane fastlane-plugin icons
Last synced: 3 months ago
JSON representation
🚩 IconBanner adds custom nice-looking banners over your mobile app icons 📱
- Host: GitHub
- URL: https://github.com/ebelair/icon-banner
- Owner: ebelair
- License: mit
- Created: 2019-04-20T21:48:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-17T23:37:01.000Z (10 months ago)
- Last Synced: 2025-07-11T08:46:06.643Z (3 months ago)
- Topics: banners, fastlane, fastlane-plugin, icons
- Language: Ruby
- Homepage:
- Size: 3.03 MB
- Stars: 35
- Watchers: 0
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/ebelair)
[](https://github.com/fastlane/fastlane/blob/master/LICENSE)
[](https://rubygems.org/gems/icon-banner)
[](https://rubygems.org/gems/fastlane-plugin-icon_banner)
**IconBanner** adds custom nice-looking banners over your mobile app icons.
It is available both as a **command-line tool** and as a **Fastlane plugin**.
## Introduction
**IconBanner** is inspired by the great [HazAT/badge](https://github.com/HazAT/badge). It provides custom banner creation on-the-fly, allowing to create different text banners for different build contexts.
It allows to create this kind of icons:
### 🍏 iOS
|Original|Daily|QA|Staging|Production|
|---|---|---|---|---|
||||||
||||||
||||||
||||||
### 🤖 Android
|Original|Daily|QA|Staging|Production|
|---|---|---|---|---|
||||||
||||||
||||||
||||||
## Setup
### 🚀 Fastlane
Start by running this command in your project repository:
```bash
fastlane add_plugin icon_banner
```
Then simply add the following actions in your Fastfile:
```ruby
lane :sample do
icon_banner([options])
# [build_ios_app and other actions]
icon_banner_restore()
end
```
For more details, see the [Usage](https://github.com/ebelair/icon-banner#options) section below.
### 💻 Standalone
First install the gem:
```bash
gem install icon-banner
```
Then use it directly from the root of your app repository:
```bash
icon-banner generate [options]
icon-banner restore
```
For more details, see the [Usage](https://github.com/ebelair/icon-banner#options) section below.
## Usage
### Generate
Generates banners and adds them to app icons. Available via:
- The `icon_banner()` Fastlane action
- The `icon-banner generate` terminal command
| Key | Description | Default |
|--------|------------------------------------|---------|
| label | Sets the text to display inside the banner | BETA |
| color | Sets the text color (when not set, the script uses the dominant icon color) | |
| font | Sets the text font with a _direct link_ to a TTF file (when not set, the script uses the embedded LilitaOne font) | |
| backup | Creates a backup of icons before applying banners (only set to `false` if you are under source-control) | true |
Sample usages:
```ruby
# fastlane
icon_banner(label: 'QA')
icon_banner(label: 'QA', color: '#ff000088', font: '/Users/johndoe/Documents/mybestfont.ttf')
```
```bash
# command-line
icon-banner generate --label QA
icon-banner generate --label QA --color '#ff000088' --font '/Users/johndoe/Documents/mybestfont.ttf'
```
### Restore
Restores app icons without banners (if backups are available). Available via:
- The `icon_banner_restore()` Fastlane action
- The `icon-banner restore` terminal command
No options are required – if backup files are available, they are automatically restored.
Sample usage:
```ruby
# fastlane
icon_banner_restore()
```
```bash
# command-line
icon-banner restore
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ebelair/icon-banner.
## License
IconBanner is ©2019 [ebelair](https://github.com/ebelair) and may be freely distributed under the [MIT license](https://opensource.org/licenses/MIT). See the [`LICENSE`](https://github.com/ebelair/icon-banner/blob/master/LICENSE.md) file.
The project is highly inspired by [`badge` by HazAT](https://github.com/HazAT/badge). Used also under the [MIT license](https://opensource.org/licenses/MIT). Thanks again. 🙏
## About ebelair
[Émile Bélair](https://github.com/ebelair) acts as a Product Owner @ [Mirego](https://www.mirego.com). He enjoys creating great products and works hard with his team to deliver some of the greatest.
