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 simple way for customers to flip through your knowledge base or reach out to your team.
The Beacon SDK requires iOS 9.0+.
Beacon is available through CocoaPods. To install it, simply add the following line to your Podfile:
pod 'Beacon'Beacon 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"Beacon can be installed manually by linking the Beacon framework and bundle. To do so, download the Beacon framework from this GitHub repo and integrate it similar to how Carthage integrates frameworks.
Next, ensure your project is linking against the following system frameworks:
UIKitFoundationMobileCoreServicesPhotosQuickLookSafariServicesUserNotificationsWebKit
Finally, ensure your project includes -all_load in its OTHER_LINKER_FLAGS build setting.
Our developer site has information on configuring up your application to work with Beacon's emails attachments and push notifications.
To run the example project in this repo, clone and run pod install from the Example directory. Once the installation is complete, open Beacon Example.xcworkspace and run the Beacon Example scheme.
See our developer site for more customization options available through the SDK.