Skip to content

Commit f2cf319

Browse files
committed
all: update readme
1 parent 685f183 commit f2cf319

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,32 @@
22

33
This repository contains Batch's iOS Extension SDK.
44

5-
It is a light version that only uses Extension-safe APIs. It provides Rich Push capabilities and other functionality.
5+
It is a light version that only uses Extension-safe APIs for extension-specific features.
66

7-
The project is written in Swift 5, but Objective-C projects are supported.
8-
If you do not have Swift code in your app and do not want to bundle the Swift runtime on versions lower than iOS 12.2,
9-
use Batch-iOS-SDK-Extension-ObjC.
7+
The project is written in Swift, but can be used with Objective-C.
108

119
## Requirements
1210

1311
- iOS 10 and higher
14-
- Xcode 11 and higher
12+
- A Xcode version that supports Swift 5 and higher
13+
14+
## Integration
15+
16+
This extension should be added to your Notification Service Extension. If you don't have one, please see [our documentation](https://doc.batch.com/ios/sdk-integration/rich-notifications-setup).
17+
18+
You will also need to configure an app group shared by your extension and app. See our [tutorial here](https://doc.batch.com/ios/advanced/app-groups).
1519

1620
### Cocoapods
1721

22+
pod 'BatchExtension'
23+
1824
### Carthage
1925

26+
github "BatchLabs/Batch-iOS-SDK-Extension"
27+
2028
### Swift Package Manager
2129

22-
Add `https://github.com/BatchLabs/Batch-iOS-SDK-Extension.git` as a dependency, and add it to your Extension target.
30+
_Requires Xcode 11_
31+
32+
Add https://github.com/BatchLabs/Batch-iOS-SDK-Extension.git as a dependency, and add it to your Extension target.
2333
You do not need to add this package to your main target.

0 commit comments

Comments
 (0)