docs: rewrite README as an install-and-initialize guide - #15
Merged
Conversation
The old README documented a PersonalizationSdk-first flow against version 0.0.1, which no longer matches the published package: `Rees46` is the entry point and the multi-instance API shipped in 0.2.0. Cover what an integrator cannot infer — the shop-id initialization contract, the cross-platform config fields, and the two platform requirements that are actually theirs to satisfy (Android minSdk 24, JitPack when repositories are centralized). Everything the plugin or the Flutter templates already provide is stated as such rather than dressed up as a manual step: the podspec pulls the pod and declares the iOS minimum, the app's Java version need not match the plugin's, and the AppDelegate stays untouched. iOS-only config fields are left out of the table, since the Android bridge does not forward them.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.