Add instructions to readme #86
Conversation
README.md
Outdated
| Add the following line into your Cartfile: | ||
|
|
||
| ``` | ||
| binary "https://raw.githubusercontent.com/phrase/ios-sdk/master/PhraseSDK.json" ~> 3.0.0 |
There was a problem hiding this comment.
we are already at Version 5.0.0, maybe we should update it here to that value
README.md
Outdated
| binary "https://raw.githubusercontent.com/phrase/ios-sdk/master/PhraseSDK.json" ~> 3.0.0 | ||
| ``` | ||
|
|
||
| Run `carthage update` and add the `PhraseApp.framework` to your project as described in the [Carthage documentation](https://github.com/Carthage/Carthage#if-youre-building-for-ios-tvos-or-watchos). |
There was a problem hiding this comment.
I lack the knowledge about carthage to make a reliable statement here. But I believe that carthage already uses xcframework.
So the correct usage would be:
carthage update --use-xcframeworks
but i'm not sure how the framework is named, maybe "PhraseApp.xcframework"
README.md
Outdated
| ### Manual installation | ||
|
|
||
| 1. Download the latest [release](https://github.com/phrase/ios-sdk/releases). | ||
| 2. Add PhraseSDK.framework in Xcode as the linked binary to the target. |
There was a problem hiding this comment.
Add PhraseSDK.xcframework
README.md
Outdated
|
|
||
| 1. Download the latest [release](https://github.com/phrase/ios-sdk/releases). | ||
| 2. Add PhraseSDK.framework in Xcode as the linked binary to the target. | ||
| 3. A script to strip the extra binaries needs to be run before you upload the app as the Apple store rejects apps including simulator binaries. |
There was a problem hiding this comment.
The run script is no longer be necessary, because of xcframework
README.md
Outdated
| Attach a callback handler to handle successful translation updates: | ||
|
|
||
| ``` | ||
| Phrase.shared.updateTranslation { result in |
There was a problem hiding this comment.
only the objc variant has a closure based callback handler.
In version 5.0.0 we use concurrency. So it would look like this:
do {
let updated = try await Phrase.shared.updateTranslation()
} catch error {
...
}
|
@carstenapploft thanks for the feedback! Tried to address all the comments |
Moving the integration instructions to the readme