fastlane_hotfix 2.187.0

data/fastlane/lib/fastlane/actions/docs/create_app_online.md

@@ -0,0 +1,386 @@
+<p align="center">
+  <img src="/img/actions/produce.png" width="250">
+</p>
+
+###### Create new iOS apps on App Store Connect and Apple Developer Portal using your command line
+
+_produce_ creates new iOS apps on both the Apple Developer Portal and App Store Connect with the minimum required information.
+
+-------
+
+<p align="center">
+    <a href="#features">Features</a> &bull;
+    <a href="#usage">Usage</a> &bull;
+    <a href="#how-does-it-work">How does it work?</a>
+</p>
+
+-------
+
+# Features
+
+- **Create** new apps on both App Store Connect and the Apple Developer Portal
+- **Modify** Application Services on the Apple Developer Portal
+- **Create** App Groups on the Apple Developer Portal
+- **Associate** apps with App Groups on the Apple Developer Portal
+- **Create** iCloud Containers on the Apple Developer Portal
+- **Associate** apps with iCloud Containers on the Apple Developer Portal
+- **Create** Merchant Identifiers on the Apple Developer Portal
+- **Associate** apps with Merchant Identifiers on the Apple Developer Portal
+- Support for **multiple Apple accounts**, storing your credentials securely in the Keychain
+
+# Usage
+
+## Creating a new application
+
+```no-highlight
+fastlane produce
+```
+
+To get a list of all available parameters:
+
+```no-highlight
+fastlane produce --help
+```
+
+```no-highlight
+Commands: (* default)
+  associate_group      Associate with a group, which is created if needed or simply located otherwise
+  associate_merchant   Associate with a merchant for use with Apple Pay. Apple Pay will be enabled for this app
+  create             * Creates a new app on App Store Connect and the Apple Developer Portal
+  disable_services     Disable specific Application Services for a specific app on the Apple Developer Portal
+  enable_services      Enable specific Application Services for a specific app on the Apple Developer Portal
+  group                Ensure that a specific App Group exists
+  cloud_container      Ensure that a specific iCloud Container exists
+  help                 Display global or [command] help documentation
+  merchant             Ensure that a specific Merchant exists
+
+Global Options:
+  --verbose
+  -h, --help           Display help documentation
+  -v, --version        Display version information
+
+Options for create:
+  -u, --username STRING Your Apple ID Username (PRODUCE_USERNAME)
+  -a, --app_identifier STRING App Identifier (Bundle ID, e.g. com.krausefx.app) (PRODUCE_APP_IDENTIFIER)
+  -e, --bundle_identifier_suffix STRING App Identifier Suffix (Ignored if App Identifier does not ends with .*) (PRODUCE_APP_IDENTIFIER_SUFFIX)
+  -q, --app_name STRING App Name (PRODUCE_APP_NAME)
+  -z, --app_version STRING Initial version number (e.g. '1.0') (PRODUCE_VERSION)
+  -y, --sku STRING     SKU Number (e.g. '1234') (PRODUCE_SKU)
+  -j, --platform STRING The platform to use (optional) (PRODUCE_PLATFORM)
+  -m, --language STRING Primary Language (e.g. 'English', 'German') (PRODUCE_LANGUAGE)
+  -c, --company_name STRING The name of your company. It's used to set company name on App Store Connect team's app pages. Only required if it's the first app you create (PRODUCE_COMPANY_NAME)
+  -i, --skip_itc [VALUE] Skip the creation of the app on App Store Connect (PRODUCE_SKIP_ITC)
+  -d, --skip_devcenter [VALUE] Skip the creation of the app on the Apple Developer Portal (PRODUCE_SKIP_DEVCENTER)
+  -s, --itc_users ARRAY Array of App Store Connect users. If provided, you can limit access to this newly created app for users with the App Manager, Developer, Marketer or Sales roles (ITC_USERS)
+  -b, --team_id STRING The ID of your Developer Portal team if you're in multiple teams (PRODUCE_TEAM_ID)
+  -l, --team_name STRING The name of your Developer Portal team if you're in multiple teams (PRODUCE_TEAM_NAME)
+  -k, --itc_team_id [VALUE] The ID of your App Store Connect team if you're in multiple teams (PRODUCE_ITC_TEAM_ID)
+  -p, --itc_team_name STRING The name of your App Store Connect team if you're in multiple teams (PRODUCE_ITC_TEAM_NAME)
+```
+
+## Enabling / Disabling Application Services
+
+If you want to enable Application Services for an App ID (HomeKit and HealthKit in this example):
+
+```no-highlight
+fastlane produce enable_services --homekit --healthkit
+```
+
+If you want to disable Application Services for an App ID (iCloud in this case):
+
+```no-highlight
+fastlane produce disable_services --icloud
+```
+
+If you want to create a new App Group:
+
+```no-highlight
+fastlane produce group -g group.krausefx -n "Example App Group"
+```
+
+If you want to associate an app with an App Group:
+
+```no-highlight
+fastlane produce associate_group -a com.krausefx.app group.krausefx
+```
+
+If you want to create a new iCloud Container:
+
+```no-highlight
+fastlane produce cloud_container -g iCloud.com.krausefx.app -n "Example iCloud Container"
+```
+
+If you want to associate an app with an iCloud Container:
+
+```no-highlight
+fastlane produce associate_cloud_container -a com.krausefx.app iCloud.com.krausefx.app
+```
+
+If you want to associate an app with multiple iCloud Containers:
+
+```no-highlight
+fastlane produce associate_cloud_container -a com.krausefx.app iCloud.com.krausefx.app1 iCloud.com.krausefx.app2
+```
+
+# Parameters
+
+Get a list of all available options using
+
+```no-highlight
+fastlane produce enable_services --help
+```
+
+```no-highlight
+--access-wifi                         Enable Access Wifi
+--app-attest                          Enable App Attest
+--app-group                           Enable App Group
+--apple-pay                           Enable Apple Pay
+--associated-domains                  Enable Associated Domains
+--auto-fill-credential                Enable Auto Fill Credential
+--class-kit                           Enable Class Kit
+--icloud STRING                        Enable iCloud, suitable values are "xcode5_compatible" and "xcode6_compatible"
+--custom-network-protocol             Enable Custom Network Protocol
+--data-protection STRING              Enable Data Protection, suitable values are "complete", "unlessopen" and "untilfirstauth"
+--extended-virtual-address-space      Enable Extended Virtual Address Space
+--game-center STRING                  Enable Game Center, suitable values are "ios" and "macos
+--health-kit                          Enable Health Kit
+--hls-interstitial-preview            Enable Hls Interstitial Preview
+--home-kit                            Enable Home Kit
+--hotspot                             Enable Hotspot
+--in-app-purchase                     Enable In App Purchase
+--inter-app-audio                     Enable Inter App Audio
+--low-latency-hls                     Enable Low Latency Hls
+--managed-associated-domains          Enable Managed Associated Domains
+--maps                                Enable Maps
+--multipath                           Enable Multipath
+--network-extension                   Enable Network Extension
+--nfc-tag-reading                     Enable NFC Tag Reading
+--personal-vpn                        Enable Personal VPN
+--passbook                            Enable Passbook (deprecated)
+--push-notification                   Enable Push Notification
+--sign-in-with-apple                  Enable Sign In With Apple
+--siri-kit                            Enable Siri Kit
+--system-extension                    Enable System Extension
+--user-management                     Enable User Management
+--vpn-configuration                   Enable Vpn Configuration (deprecated)
+--wallet                              Enable Wallet
+--wireless-accessory                  Enable Wireless Accessory
+--car-play-audio-app                  Enable Car Play Audio App
+--car-play-messaging-app              Enable Car Play Messaging App
+--car-play-navigation-app             Enable Car Play Navigation App
+--car-play-voip-calling-app           Enable Car Play Voip Calling App
+--critical-alerts                     Enable Critical Alerts
+--hotspot-helper                      Enable Hotspot Helper
+--driver-kit                          Enable DriverKit
+--driver-kit-endpoint-security        Enable DriverKit Endpoint Security
+--driver-kit-family-hid-device        Enable DriverKit Family HID Device
+--driver-kit-family-networking        Enable DriverKit Family Networking
+--driver-kit-family-serial            Enable DriverKit Family Serial
+--driver-kit-hid-event-service        Enable DriverKit HID EventService
+--driver-kit-transport-hid            Enable DriverKit Transport HID
+--multitasking-camera-access          Enable Multitasking Camera Access
+--sf-universal-link-api               Enable SFUniversalLink API
+--vp9-decoder                         Enable VP9 Decoder
+--music-kit                           Enable MusicKit
+--shazam-kit                          Enable ShazamKit
+--communication-notifications         Enable Communication Notifications
+--group-activities                    Enable Group Activities
+--health-kit-estimate-recalibration   Enable HealthKit Estimate Recalibration
+--time-sensitive-notifications        Enable Time Sensitive Notifications
+```
+
+```no-highlight
+fastlane produce disable_services --help
+```
+
+```no-highlight
+--access-wifi                         Disable Access Wifi
+--app-attest                          Disable App Attest
+--app-group                           Disable App Group
+--apple-pay                           Disable Apple Pay
+--associated-domains                  Disable Associated Domains
+--auto-fill-credential                Disable Auto Fill Credential
+--class-kit                           Disable Class Kit
+--icloud STRING                        Disable iCloud
+--custom-network-protocol             Disable Custom Network Protocol
+--data-protection STRING              Disable Data Protection
+--extended-virtual-address-space      Disable Extended Virtual Address Space
+--game-center STRING                  Disable Game Center
+--health-kit                          Disable Health Kit
+--hls-interstitial-preview            Disable Hls Interstitial Preview
+--home-kit                            Disable Home Kit
+--hotspot                             Disable Hotspot
+--in-app-purchase                     Disable In App Purchase
+--inter-app-audio                     Disable Inter App Audio
+--low-latency-hls                     Disable Low Latency Hls
+--managed-associated-domains          Disable Managed Associated Domains
+--maps                                Disable Maps
+--multipath                           Disable Multipath
+--network-extension                   Disable Network Extension
+--nfc-tag-reading                     Disable NFC Tag Reading
+--personal-vpn                        Disable Personal VPN
+--passbook                            Disable Passbook (deprecated)
+--push-notification                   Disable Push Notification
+--sign-in-with-apple                  Disable Sign In With Apple
+--siri-kit                            Disable Siri Kit
+--system-extension                    Disable System Extension
+--user-management                     Disable User Management
+--vpn-configuration                   Disable Vpn Configuration (deprecated)
+--wallet                              Disable Wallet
+--wireless-accessory                  Disable Wireless Accessory
+--car-play-audio-app                  Disable Car Play Audio App
+--car-play-messaging-app              Disable Car Play Messaging App
+--car-play-navigation-app             Disable Car Play Navigation App
+--car-play-voip-calling-app           Disable Car Play Voip Calling App
+--critical-alerts                     Disable Critical Alerts
+--hotspot-helper                      Disable Hotspot Helper
+--driver-kit                          Disable DriverKit
+--driver-kit-endpoint-security        Disable DriverKit Endpoint Security
+--driver-kit-family-hid-device        Disable DriverKit Family HID Device
+--driver-kit-family-networking        Disable DriverKit Family Networking
+--driver-kit-family-serial            Disable DriverKit Family Serial
+--driver-kit-hid-event-service        Disable DriverKit HID EventService
+--driver-kit-transport-hid            Disable DriverKit Transport HID
+--multitasking-camera-access          Disable Multitasking Camera Access
+--sf-universal-link-api               Disable SFUniversalLink API
+--vp9-decoder                         Disable VP9 Decoder
+--music-kit                           Disable MusicKit
+--shazam-kit                          Disable ShazamKit
+--communication-notifications         Disable Communication Notifications
+--group-activities                    Disable Group Activities
+--health-kit-estimate-recalibration   Disable HealthKit Estimate Recalibration
+--time-sensitive-notifications        Disable Time Sensitive Notifications
+```
+
+## Creating Apple Pay merchants and associating them with an App ID
+
+If you want to create a new Apple Pay Merchant Identifier:
+
+```no-highlight
+fastlane produce merchant -o merchant.com.example.production -r "Example Merchant Production"
+```
+
+Use `--help` for more information about all available parameters
+
+```no-highlight
+fastlane produce merchant --help
+```
+
+If you want to associate an app with a Merchant Identifier:
+
+```no-highlight
+fastlane produce associate_merchant -a com.krausefx.app merchant.com.example.production
+```
+
+If you want to associate an app with multiple Merchant Identifiers:
+
+```no-highlight
+fastlane produce associate_merchant -a com.krausefx.app merchant.com.example.production merchant.com.example.sandbox
+```
+
+Use --help for more information about all available parameters
+
+```no-highlight
+fastlane produce associate_merchant --help
+```
+
+## Environment Variables
+
+All available values can also be passed using environment variables, run `fastlane produce --help` to get a list of all available parameters.
+
+## _fastlane_ Integration
+
+Your `Fastfile` should look like this
+
+```ruby
+lane :release do
+  produce(
+    username: 'felix@krausefx.com',
+    app_identifier: 'com.krausefx.app',
+    app_name: 'MyApp',
+    language: 'English',
+    app_version: '1.0',
+    sku: '123',
+    team_name: 'SunApps GmbH', # only necessary when in multiple teams
+    
+    # Optional
+    # App services can be enabled during app creation
+    enable_services: {
+      access_wifi: "on",                        # Valid values: "on", "off"
+      app_attest: "on",                         # Valid values: "on", "off"
+      app_group: "on",                          # Valid values: "on", "off"
+      apple_pay: "on",                          # Valid values: "on", "off"
+      associated_domains: "on",                 # Valid values: "on", "off"
+      auto_fill_credential: "on",               # Valid values: "on", "off"
+      car_play_audio_app: "on",                 # Valid values: "on", "off"
+      car_play_messaging_app: "on",             # Valid values: "on", "off"
+      car_play_navigation_app: "on",            # Valid values: "on", "off"
+      car_play_voip_calling_app: "on",          # Valid values: "on", "off"
+      class_kit: "on",                          # Valid values: "on", "off"
+      icloud: "xcode5_compatible",              # Valid values: "xcode5_compatible", "xcode6_compatible", "off"
+      critical_alerts: "on",                    # Valid values: "on", "off"
+      custom_network_protocol: "on",            # Valid values: "on", "off"
+      data_protection: "complete",              # Valid values: "complete", "unlessopen", "untilfirstauth", "off"
+      extended_virtual_address_space: "on",     # Valid values: "on", "off"
+      file_provider_testing_mode: "on",         # Valid values: "on", "off"
+      fonts: "on",                              # Valid values: "on", "off"
+      game_center: "ios",                       # Valid values: "ios", "macos", off"
+      health_kit: "on",                         # Valid values: "on", "off"
+      hls_interstitial_preview: "on",           # Valid values: "on", "off"
+      home_kit: "on",                           # Valid values: "on", "off"
+      hotspot: "on",                            # Valid values: "on", "off"
+      hotspot_helper: "on",                     # Valid values: "on", "off"
+      in_app_purchase: "on",                    # Valid values: "on", "off"
+      inter_app_audio: "on",                    # Valid values: "on", "off"
+      low_latency_hls: "on",                    # Valid values: "on", "off"
+      managed_associated_domains: "on",         # Valid values: "on", "off"
+      maps: "on",                               # Valid values: "on", "off"
+      multipath: "on",                          # Valid values: "on", "off"
+      network_extension: "on",                  # Valid values: "on", "off"
+      nfc_tag_reading: "on",                    # Valid values: "on", "off"
+      passbook: "on",                           # Valid values: "on", "off" (deprecated)
+      personal_vpn: "on",                       # Valid values: "on", "off"
+      push_notification: "on",                  # Valid values: "on", "off"
+      sign_in_with_apple: "on",                 # Valid values: "on", "off"
+      siri_kit: "on",                           # Valid values: "on", "off"
+      system_extension: "on",                   # Valid values: "on", "off"
+      user_management: "on",                    # Valid values: "on", "off"
+      vpn_configuration: "on",                  # Valid values: "on", "off" (deprecated)
+      wallet: "on",                             # Valid values: "on", "off"
+      wireless_accessory: "on",                 # Valid values: "on", "off"
+      driver_kit: "on",                         # Valid values: "on", "off"
+      driver_kit_endpoint_security: "on",       # Valid values: "on", "off"
+      driver_kit_family_hid_device: "on",       # Valid values: "on", "off"
+      driver_kit_family_networking: "on",       # Valid values: "on", "off"
+      driver_kit_family_serial: "on",           # Valid values: "on", "off"
+      driver_kit_hid_event_service: "on",       # Valid values: "on", "off"
+      driver_kit_transport_hid: "on",           # Valid values: "on", "off"
+      multitasking_camera_access: "on",         # Valid values: "on", "off"
+      sf_universal_link_api: "on",              # Valid values: "on", "off"
+      vp9_decoder: "on",                        # Valid values: "on", "off"
+      music_kit: "on",                          # Valid values: "on", "off"
+      shazam_kit: "on",                         # Valid values: "on", "off"
+      communication_notifications: "on",        # Valid values: "on", "off"
+      group_activities: "on",                   # Valid values: "on", "off"
+      health_kit_estimate_recalibration: "on",  # Valid values: "on", "off"
+      time_sensitive_notifications: "on",       # Valid values: "on", "off"
+    }
+  )
+
+  deliver
+end
+```
+
+To use the newly generated app in _deliver_, you need to add this line to your `Deliverfile`:
+
+```ruby-skip-tests
+apple_id(ENV['PRODUCE_APPLE_ID'])
+```
+
+This will tell _deliver_, which `App ID` to use, since the app is not yet available in the App Store.
+
+You'll still have to fill out the remaining information (like screenshots, app description and pricing). You can use [_deliver_](https://docs.fastlane.tools/actions/deliver/) to upload your app metadata using a CLI
+
+## How is my password stored?
+
+_produce_ uses the [password manager](https://github.com/fastlane/fastlane/tree/master/credentials_manager) from _fastlane_. Take a look the [CredentialsManager README](https://github.com/fastlane/fastlane/tree/master/credentials_manager) for more information.

data/fastlane/lib/fastlane/actions/docs/frame_screenshots.md

@@ -0,0 +1,366 @@
+<p align="center">
+  <img src="/img/actions/frameit.png" width="250">
+</p>
+
+###### Easily put your screenshots into the right device frames
+
+_frameit_ allows you to put a gorgeous device frame around your iOS, macOS and Android screenshots just by running one simple command. Use _frameit_ to prepare perfect screenshots for the App Store, your website, QA or emails.
+
+-------
+
+<p align="center">
+    <a href="#features">Features</a> &bull;
+    <a href="#usage">Usage</a> &bull;
+    <a href="#tips">Tips</a>
+</p>
+
+-------
+
+<h5 align="center"><em>frameit</em> is part of <a href="https://fastlane.tools">fastlane</a>: The easiest way to automate beta deployments and releases for your iOS and Android apps.</h5>
+
+
+# Features
+
+## Frame screenshot
+
+Put a gorgeous device frame around your iOS, macOS and Android screenshots just by running one simple command. Support for:
+
+- iPhone, iPad and Mac
+- Set of Android devices
+- Portrait and Landscape modes
+- Several device frame colors
+
+The complete and updated list of supported devices and colors can be found [here](https://github.com/fastlane/frameit-frames/tree/gh-pages/latest)
+
+Here is a nice gif, that shows _frameit_ in action:
+
+![img/actions/FrameitGit.gif](/img/actions/FrameitGit.gif?raw=1)
+
+## Advanced Features
+
+- Put framed screenshot on colored background, define padding
+- add text above or under framed screenshot
+  - keyword + text
+  - choose text font and color
+  - multi line text
+  - "intelligent" positioning of text that always looks good(ish)
+
+## Results
+
+![img/actions/ScreenshotsBig.png](/img/actions/ScreenshotsBig.png?raw=1)
+
+-------
+
+![img/actions/ScreenshotsOverview.png](/img/actions/ScreenshotsOverview.png?raw=1)
+
+-------
+
+![img/actions/MacExample.png](/img/actions/MacExample.png?raw=1)
+
+<h5 align="center">The <em>frameit</em> 2.0 update was kindly sponsored by <a href="https://mindnode.com/">MindNode</a>, seen in the screenshots above.</h5>
+
+
+The first time that _frameit_ is executed the frames will be downloaded automatically. Originally the frames are coming from [Facebook frameset](http://facebook.design/devices) and they are kept on [this repo](https://github.com/fastlane/frameit-frames).
+
+More information about this process and how to update the frames can be found [here](https://github.com/fastlane/fastlane/tree/master/frameit/frames_generator)
+
+# Usage
+
+## Basic Usage
+
+Why should you have to use Photoshop, just to add a frame around your screenshots?
+
+Just navigate to your folder of screenshots and use the following command (iOS and Mac OS are default platforms for backward compatibility):
+
+```no-highlight
+fastlane frameit
+```
+
+To frame Android screenshots:
+
+```no-highlight
+fastlane frameit android
+```
+
+To use the silver version of the frames:
+
+```no-highlight
+fastlane frameit silver
+```
+
+To download the latest frames
+
+```no-highlight
+fastlane frameit download_frames
+```
+
+Note: When using _frameit_ without titles on top, the screenshots will have the full resolution, which means they can't be uploaded to the App Store directly. They are supposed to be used for websites, print media and emails. Check out the section below to use the screenshots for the App Store.
+
+## Advanced Usage (optional)
+
+### Text and Background
+
+With _frameit_ it's possible to add a custom background and text below or above the framed screenshots in fonts and colors you define.
+
+A working example can be found in the [fastlane examples](https://github.com/fastlane/examples/tree/master/MindNode/screenshots) project.
+
+### `Framefile.json`
+
+The Framefile allows to define general and screenshot specific information.
+It has the following general JSON structure:
+
+```json
+{
+  "device_frame_version": "latest",
+  "default": {
+    ...
+  },
+  "data": [
+     ...
+  ]
+}
+```
+
+### General parameters
+
+The general parameters are defined in the `default` key and can be:
+
+| Key | Description | Default value |
+|-----|-------------|---------------|
+| `background` | The background that should be used for the framed screenshot. Specify the (relative) path to the image file (e.g. `*.jpg`). This parameter is mandatory. | NA |
+| `keyword` | An object that contains up to 3 keys to describe the optional keyword. See [table](#keyword-and-title-parameters) below. | NA |
+| `title` | An object that contains up to 3 keys to describe the mandatory title. See [table](#keyword-and-title-parameters) below. | NA |
+| `stack_title` | Specifies whether _frameit_ should display the keyword above the title when both keyword and title are defined. If it is false, the title and keyword will be displayed side by side when both keyword and title are defined. | `false` |
+| `title_below_image` | Specifies whether _frameit_ should place the title and optional keyword below the device frame. If it is false, it will be placed above the device frame. | `false` |
+| `show_complete_frame` | Specifies whether _frameit_ should shrink the device frame so that it is completely shown in the framed screenshot. If it is false, clipping of the device frame might occur at the bottom (when `title_below_image` is `false`) or top (when `title_below_image` is `true`) of the framed screenshot. | `false` |
+| `padding` | The content of the framed screenshot will be resized to match the specified `padding` around all edges. The vertical padding is also applied between the text and the top or bottom (depending on `title_below_image`) of the device frame. <p> There are 3 different options of specifying the padding: <p> 1. Default: An integer value that defines both horizontal and vertical padding in pixels. <br> 2. A string that defines (different) padding values in pixels for horizontal and vertical padding. The syntax is `"<horizontal>x<vertical>"`, e.g. `"30x60"`. <br> 3. A string that defines (different) padding values in percentage for horizontal and vertical padding. The syntax is `"<horizontal>%x<vertical>%"`, e.g. `"5%x10%"`. <br> **Note:** The percentage is calculated from the smallest image dimension (height or width). <p> A combination of option 2 and 3 is possible, e.g. `"5%x40"`. | `50` |
+| `interline_spacing` | Specifies whether _frameit_ should add or subtract this many pixels between the individual lines of text. This only applies to a multi-line `title` and/or `keyword` to expand or squash together the individual lines of text. | `0` |
+| `font_scale_factor` | Specifies whether _frameit_ should increase or decrease the font size of the text. Is ignored for `keyword` or `title`, if `font_size` is specified. | `0.1` |
+| `frame` | Overrides the color of the frame to be used. (Valid values are `BLACK`, `WHITE`, `GOLD` and `ROSE_GOLD`) | NA |
+| `title_min_height` | Specifies a height always reserved for the title. Value can be a percentage of the height or an absolute value. The device will be placed below (or above) this area. Convenient to ensure the device top (or bottom) will be consistently placed at the same height on the different screenshots. | NA |
+| `use_platform` | Overrides the platform used for the screenshot. Valid values are `IOS`, `ANDROID` and `ANY`. | `IOS` |
+| `force_device_type` | Forces a specific device. Valid values are: Huawei P8, Motorola Moto E, Motorola Moto G, Nexus 4, Nexus 5X, Nexus 6P, Nexus 9, Samsung Galaxy Grand Prime, Samsung Galaxy Note 5, Samsung Galaxy S Duos, Samsung Galaxy S3, Samsung Galaxy S5, Samsung Galaxy S7, Samsung Galaxy S8, Samsung Galaxy S9, iPhone 5s, iPhone 5c, iPhone SE, iPhone 6s, iPhone 6s Plus, iPhone 7, iPhone 7 Plus, iPhone 8, iPhone 8 Plus, iPhone X, iPhone XS, iPhone XR, iPhone XS Max, iPad Air 2, iPad Mini 4, iPad Pro, MacBook, Google Pixel 3, Google Pixel 3 XL, HTC One A9, HTC One M8 | NA |
+
+### Specific parameters
+
+The screenshot specific parameters are related to the keyword and title texts.
+These are defined in the `data` key. This is an array with the following keys for each screenshot:
+
+| Key | Description |
+|-----|-------------|
+| `filter` | This is mandatory to link the individual configuration to the screenshot, based on part of the file name. <p>Example:<br>If a screenshot is named `iPhone 8-Brainstorming.png` you can use value `Brainstorming` for `filter`.  If there are more than one `filter` matching an entry, they will all be applied in order (which means that the last one has the highest precedence). All other keys from that array element will only be applied on this specific screenshot. |
+| `keyword` | Similar use as in `default`, except that parameter `text` can be used here because it is screenshot specific. |
+| `title` | Similar use as in `default`, except that parameter `text` can be used here because it is screenshot specific. |
+| `frame` | Overrides the color of the frame to be used. (Valid values are `BLACK`, `WHITE`, `GOLD` and `ROSE_GOLD`) | NA |
+| `use_platform` | Overrides the platform used for the screenshot. Valid values are `IOS`, `ANDROID` and `ANY`. | `IOS` |
+| `force_device_type` | Forces a specific device. Valid values are the same as for the general parameter. | NA |
+
+### <a name="keyword-and-title-parameters"></a>Framefile `keyword` and `title` parameters
+
+The `keyword` and `title` parameters are both used in `default` and `data`. They both consist of the following optional keys:
+
+| Key | Description | Default value |
+|-----|-------------|---------------|
+| `color` | The font color for the text. Specify a HEX/HTML color code. | `#000000` (black) |
+| `font` | The font family for the text. Specify the (relative) path to the font file (e.g. an OpenType Font). | The default `imagemagick` font, which is system dependent. |
+| `font_size` | The font size for the text specified in points. If not specified or `0`, font will be scaled automatically to fit the available space. _frameit_ still shrinks the text, if it would not fit. | NA |
+| `font_weight` | The [font weight for the text](https://imagemagick.org/script/command-line-options.php#weight). Specify an integer value (e.g. 900). | NA |
+| `text` | The text that should be used for the `keyword` or `title`. <p> Note: If you want to use localised text, use [`.strings` files](#strings-files). | NA |
+
+### Example
+
+```json
+{
+  "device_frame_version": "latest",
+  "default": {
+    "keyword": {
+      "font": "./fonts/MyFont-Rg.otf"
+    },
+    "title": {
+      "font": "./fonts/MyFont-Th.otf",
+      "font_size": 128,
+      "color": "#545454"
+    },
+    "background": "./background.jpg",
+    "padding": 50,
+    "show_complete_frame": false,
+    "stack_title" : false,
+    "title_below_image": true,
+    "frame": "WHITE",
+    "use_platform": "IOS"
+  },
+
+  "data": [
+    {
+      "filter": "Brainstorming",
+      "keyword": {
+        "color": "#d21559"
+      }
+    },
+    {
+      "filter": "Organizing",
+      "keyword": {
+        "color": "#feb909"
+      },
+      "frame": "ROSE_GOLD"
+    },
+    {
+      "filter": "Sharing",
+      "keyword": {
+        "color": "#aa4dbc"
+      }
+    },
+    {
+      "filter": "Styling",
+      "keyword": {
+        "color": "#31bb48"
+      }
+    },
+    {
+      "filter": "Android",
+      "use_platform": "ANDROID"
+    }
+  ]
+}
+```
+
+You can find a more complex [configuration](https://github.com/fastlane/examples/blob/master/MindNode/screenshots/Framefile.json) to also support Chinese, Japanese and Korean languages.
+
+The `Framefile.json` should be in the `screenshots` folder, as seen in the [example](https://github.com/fastlane/examples/tree/master/MindNode/screenshots).
+
+### `.strings` files
+
+To define the title and optionally the keyword, put two `.strings` files into the language folder (e.g. [en-US in the example project](https://github.com/fastlane/examples/tree/master/MindNode/screenshots/en-US))
+
+The `keyword.strings` and `title.strings` are standard `.strings` file you already use for your iOS apps, making it easy to use your existing translation service to get localized titles.
+
+**Notes**
+
+- These `.strings` files **MUST** be utf-8 (UTF-8) or utf-16 encoded (UTF-16 BE with BOM). They also must begin with an empty line. If you are having trouble see [issue #1740](https://github.com/fastlane/fastlane/issues/1740)
+- You **MUST** provide a background if you want titles. _frameit_ will not add the titles if a background is not specified.
+
+### Screenshot orientation
+
+By default _frameit_ adds a frame to your screenshot based on an orientation you took it. For a portrait (vertical orientation) it is going to add portrait frame and for a landscape (horizontal orientation) - landscape left (= [Home button on the left side](https://developer.apple.com/documentation/uikit/uiinterfaceorientation/landscapeleft)).
+
+One way to override the default behavior is editing the file name by adding `force_landscaperight` to the end.
+
+### `force_orientation_block`
+
+If the default behavior doesn't fit your needs and you don't want or can't rename your screenshots, you can customize _frameit_'s orientation behavior by setting a `force_orientation_block` parameter. The valid values are: `:landscape_left` (home button on the left side), `:landscape_right` (home button on the right side), `:portrait` (home button on the bottom), `nil` (home button on the right side).
+
+### Examples
+
+```ruby
+# It matches the filename to the framed device orientation
+frameit(
+  path: "./fastlane/screenshots",
+  force_orientation_block: proc do |filename|
+    case filename
+      when "iPad Pro (12.9-inch)-01LoginScreen"
+        :landscape_right
+      when "iPhone 6 Plus-01LoginScreen"
+        :portrait
+      # and so on
+    end
+  end
+)
+```
+
+```ruby
+# It frames the screenshots in landscape right whenever the filename contains `landscape` word
+frameit(
+  silver: true,
+  path: "./fastlane/screenshots",
+  force_orientation_block: proc do |filename|
+    f = filename.downcase
+    if f.include?("landscape")
+      :landscape_right
+    end
+  end
+)
+```
+
+# Mac
+
+With _frameit_ it's possible to also frame macOS Application screenshots. You have to provide the following:
+
+- A (relative) path to a `background` image file, which should contain both the background and the Mac.
+- The `offset` information so _frameit_ knows where to position your screenshot on the `background`:
+  - `offset` : A string that specifies the horizontal and vertical offset in pixels, with respect to the top left corner of the `background` image. The syntax is `"+<horizontal>+<vertical>"`, e.g. `"+200+150"`.
+  - `titleHeight` : The height in pixels that should be used for the title.
+
+## Example
+```json
+{
+  "default": {
+    "title": {
+      "color": "#545454"
+    },
+    "background": "Mac.jpg",
+    "offset": {
+      "offset": "+676+479",
+      "titleHeight": 320
+    }
+  },
+  "data": [
+    {
+      "filter": "Brainstorming",
+      "keyword": {
+        "color": "#d21559"
+      }
+    }
+  ]
+}
+```
+
+Check out the [MindNode example project](https://github.com/fastlane/examples/tree/master/MindNode/screenshots).
+
+# Tips
+
+## Generate localized screenshots
+
+Check out [_snapshot_](https://docs.fastlane.tools/actions/snapshot/) to automatically generate screenshots using ```UI Automation```.
+
+## Resume framing
+
+Framing screenshots is a slow operation. In case you need to resume framing, or just frame a couple updated screenshots again, you can rely on the `--resume` flag. Only screenshots which have not been framed yet – or for which there isn't an up-to-date framed image – will be framed. This feature uses the file modification dates and will reframe screenshots if the screenshot is newer than the framed file.
+
+## Upload screenshots
+
+Use [_deliver_](https://docs.fastlane.tools/actions/deliver/) to upload iOS screenshots to App Store Connect, or [_supply_](https://docs.fastlane.tools/actions/supply/) to upload Android screenshots to Play Store completely automatically 🚀
+
+## Use a clean status bar
+
+You can set `override_status_bar` to `true` in snapshot to set the status bar to Tuesday January 9th at 9:41AM with full battery and reception. If you need more granular customization, to set a Carrier name for example, also set `override_status_bar_arguments` to the specific arguments to be passed to the `xcrun simctl status_bar override` command. Run `xcrun simctl status_bar --help` to see the options available.
+
+### Examples
+
+```ruby
+# Sets the time to 9:41AM with full battery and reception, with the default carrier name: Carrier
+capture_ios_screenshots(
+	override_status_bar: true
+)
+```
+
+```ruby
+# Set the time to 9:41AM, battery at 75% and charging, on the TELUS LTE network
+capture_ios_screenshots(
+	override_status_bar: true,
+	override_status_bar_arguments: "--time 9:41 --dataNetwork lte --cellularMode active --cellularBars 4 --batteryState charging --batteryLevel 75 --operatorName TELUS"
+)
+```
+
+## Gray artifacts around text
+
+If you run into any quality issues, like having a border around the font, it usually helps to just re-install `imagemagick`. You can do so by running
+
+```sh
+brew uninstall imagemagick
+brew install imagemagick
+```
+
+## Uninstall
+
+- `gem uninstall fastlane`
+- `rm -rf ~/.frameit`