Skip to content

Latest commit

 

History

History
77 lines (52 loc) · 3.11 KB

README.md

File metadata and controls

77 lines (52 loc) · 3.11 KB
Raw

Adobe Experience Platform - Places extension for iOS

Cocoapods SPM CircleCI

About this project

Adobe Experience Platform Places Extension is an extension for the Adobe Experience Platform Swift SDK.

The AEPPlaces extension allows you to track geolocation events as defined in the Adobe Places UI and in Adobe Launch rules.

Requirements

  • Xcode 15
  • Swift 5.1 or newer

Installation

Binaries

To generate AEPPlaces.xcframework, run the following command from the root directory:

make archive

This will do a pod install then generate an XCFramework under the build folder. Drag and drop AEPPlaces.xcframework to your app target.

CocoaPods

# Podfile
use_frameworks!

target 'YOUR_TARGET_NAME' do
      pod 'AEPPlaces'
end

Swift Package Manager

To add the AEPPlaces package to your application, from the Xcode menu select:

File > Add Packages...

Note: the menu options may vary depending on the version of Xcode being used.

Enter the URL for the AEPPlaces package repository: https://github.com/adobe/aepsdk-places-ios.git.

For Dependency Rule, select Up to Next Major Version.

Alternatively, if your project has a Package.swift file, you can add AEPPlaces directly to your dependencies:

dependencies: [
    .package(url: "https://github.com/adobe/aepsdk-places-ios.git", .upToNextMajor(from: "5.0.0"))
],
targets: [
    .target(name: "YourTarget",
            dependencies: ["AEPPlaces"],
            path: "your/path")
]

Documentation

Additional documentation for configuration and SDK usage can be found under the Documentation directory.

PlacesTestApp & PlacesTestApp_objc

Two sample apps are provided (one each for Swift and Objective-c) which demonstrate retrieving nearby Points of Interest and triggering region events. Their targets are in AEPPlaces.xcodeproj, runnable in AEPPlaces.xcworkspace. Sample app source code can be found in the TestApps directory.

Contributing

Looking to contribute to this project? Please review our Contributing guidelines prior to opening a pull request.

We look forward to working with you!

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.