Skip to content

Commit

Permalink
Merge pull request adobe#21 from adobe/sbenedicadb-patch-1
Browse files Browse the repository at this point in the history
add beta language, update spm installation text
  • Loading branch information
shalehaha authored Sep 24, 2020
2 parents b8a7681 + c388836 commit b7e2b7d
Showing 1 changed file with 20 additions and 5 deletions.
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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"))
]
```

Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit b7e2b7d

Please sign in to comment.