Merge pull request #90 from phrase/add_migration_guide

Migration Guide

Author: jan-reehuis-apploft

MIGRATION.md

@@ -0,0 +1,39 @@
+# Phrase Over-the-Air Migration Guide
+
+### Update to v3.11.x+
+Version 3.11.0 begins the process of removing the Android Context wrapping by Phrase. 
+
+Wrapping the Android Context can lead to severe issues with other libraries. E.g. App crashes can occur in combination with WebViews.
+
+#### Suggested Actions:
+- Replace `super.attachBaseContext(Phrase.wrapContext(base))` with `super.attachBaseContext(base)` in your Application class.
+- Replace `Phrase.getDelegate(super.getDelegate())` with `Phrase.getDelegate(super.getDelegate(), wrapContext = false)` in your Activities.
+- Replace Android resource calls with the Phrase equivalents:
+
+  |Android Resource Call|Phrase Equivalent|
+  |-------------|--------------|
+  |`Context.getString()`|`Context.getPhraseString()`|
+  |`Context.getText()`|`Context.getPhraseText()`|
+  |`Context.getStringArray()`|`Context.getPhraseStringArray()`|
+  |`Context.getTextArray()`|`Context.getPhraseTextArray()`|
+  |`Context.getQuantityString()`|`Context.getPhraseQuantityString()`|
+  |`Context.getQuantityText()`|`Context.getPhraseQuantityText()`|
+  |`Resources.getString()`|`Resources.getPhraseString()`|
+  |`Resources.getText()`|`Resources.getPhraseText()`|
+  |`Resources.getStringArray()`|`Resources.getPhraseStringArray()`|
+  |`Resources.getTextArray()`|`Resources.getPhraseTextArray()`|
+  |`Resources.getQuantityString()`|`Resources.getPhraseQuantityString()`|
+  |`Resources.getQuantityText()`|`Resources.getPhraseQuantityText()`|
+  |`TypedArray.getString()`|`TypedArray.getStringWithPhrase()`|
+  |`TypedArray.getText()`|`TypedArray.getTextWithPhrase()`|
+- Remove all `Phrase {}` wrapper composable calls if you used Phrase in Compose previously.
+- Use the Phrase calls to retrieve translations in Compose:
+
+  |Phrase OTA Composables|
+  |-------|
+  |`phraseString()`|
+  |`phraseText()`|
+  |`phraseStringArray()`|
+  |`phraseTextArray()`|
+  |`phraseQuantityString()`|
+  |`phraseQuantityText()`|

README.md

@@ -51,6 +51,9 @@ class MainApplication : Application {
 }
 ```
 
+### Update to a new Version
+When updating the Phrase OTA SDK, please check the [migration guide](MIGRATION.md) if you need or should adapt your code to the changes.
+
 ### Jetpack Compose Support
 Use Phrase provided composables to get the translations: `phraseString(R.string.translation_key)`.