Beacon-iOS

2.1.2

The Beacon iOS SDK
helpscout/beacon-ios-sdk

What's New

2.1.2

2020-11-19T21:28:32Z

Release 2.1.2

Beacon SDK

CocoaPods Compatible

Help Scout's Beacon SDK allows you to embed the same Beacon functionality we have for the web inside your iOS app. Beacons provide a quick and straightforward way for customers to flip through your knowledge base or reach out to your team.

Requirements

The Beacon SDK 2.0 requires iOS 11.0+.

As of Beacon 2.1.0 Xcode 12 is required to build with the Beacon SDK. Beacon 2.0.x requires Xcode 11.4

Installation

CocoaPods

Beacon is available through CocoaPods. To install it, add the following line to your Podfile:

pod 'Beacon'

Beacon is currently distributed as a dynamic framework so the use_frameworks! flag will also need to be present in your Podfile.

Carthage 🛑

As of Beacon 2.1.0, Beacon is (temporarily 🤞) no longer available to be distributed via Carthage. This is because Beacon is now distributed as an XCFramework which is (as of October 29th, 2020) not supported by Carthage. More info about the progress the Carthage team is making can be found on this issue or the following Pull Requests 1, 2.

Beacons up to version 2.0.2 can be installed using Carthage by adding the following line to your Cartfile and then following the Carthage installation instructions:

github "helpscout/beacon-ios-sdk"

Because of the way Beacon is distributed, attempting to use the --no-use-binaries flag when building will fail.

Manually

Beacon can be installed manually by linking the Beacon.xcframework. To do so, download the Beacon.xcframework.zip from here and add Beacon.xcframework to your Xcode project.

Additional Setup

Our developer site has information on configuring up your application to work with Beacon's email attachments and push notifications.

Sample Application

To run the example project in this repo, cd into the Example directory cd Example, run pod install, open Beacon Example.xcworkspace and run the BeaconExample scheme.

Documentation

See our developer site for more customization options available through the SDK.

Description

  • Swift Tools 5.3.0

Dependencies

  • None
Last updated: Fri Dec 04 2020 17:48:19 GMT-0500 (GMT-05:00)