Skip to content

Commit

Permalink
add documentation for access groups
Browse files Browse the repository at this point in the history
  • Loading branch information
gadphly committed Sep 29, 2023
1 parent 233db37 commit 9071de7
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ Trifle SDK is implemented on client side in iOS and Android and on server side i

```swift
// App start up
let trifle = try Trifle(reverseDomain: abc)
// The access group value must be added to the App Groups [entitlement file](https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_application-groups).
let trifle = try Trifle(reverseDomain: abc, accessGroup: "group.trifle.cash.app")

// Check if a key already exists.
// If no key exists, generate a public key pair
Expand Down
1 change: 1 addition & 0 deletions ios/Trifle/Sources/Trifle.swift
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ public class Trifle {
attribute will mean that all key related APIs will be limited to the specified access group
(of which the calling application must be a member to obtain matching results.)
It is recommended that this value is set.
** This value must be added to the App Group entitlement file. **

If the access group is not set, Trifle keys are created in the application's default access group.
*/
Expand Down

0 comments on commit 9071de7

Please sign in to comment.