From c38883677cda76298332b62c76b4180598c88657 Mon Sep 17 00:00:00 2001 From: Steve Benedick Date: Thu, 24 Sep 2020 10:29:20 -0600 Subject: [PATCH] add beta language, update spm installation text --- README.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d3decc5..cedfc12 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,36 @@ # AEPRulesEngine +## BETA + +AEPRulesEngine is currently in beta. Use of this code is by invitation only and not otherwise supported by Adobe. Please contact your Adobe Customer Success Manager to learn more. + ## Overview A simple, generic, extensible Rules Engine in Swift. - ## Installation ### Swift Package Manager -Once you have your Swift package set up, adding RuleEngine as a dependency is as easy as adding it to the dependencies value of your Package.swift. +To add the AEPRulesEngine Package to your application, from the Xcode menu select: + +`File > Swift Packages > Add Package Dependency...` + +Enter the URL for the AEPRulesEngine package repository: `https://github.com/adobe/aepsdk-rulesengine-ios.git`. + +When prompted, make sure you change the branch to `main`. + +There are three options for selecting your dependencies as identified by the *suffix* of the library name: + +- "Dynamic" - the library will be linked dynamically +- "Static" - the library will be linked statically +- *(none)* - (default) SPM will determine whether the library will be linked dynamically or statically + +Alternatively, if your project has a `Package.swift` file, you can add AEPRulesEngine directly to your dependencies: -Example: ``` dependencies: [ -.package(url: "https://github.com/adobe/aepsdk-rulesengine-ios.git", from: "0.0.1") + .package(url: "https://github.com/adobe/aepsdk-rulesengine-ios.git", .branch("main")) ] ``` @@ -55,7 +71,6 @@ let matchedRules = rulesEngine.evaluate(data: ["company":"adobe"]) ``` - ## Contributing Contributions are welcomed! Read the [Contributing Guide](./.github/CONTRIBUTING.md) for more information.