docs: clarify Expo-only requirement and add peer dependency table#12
Open
blick wants to merge 2 commits intocookie-information:mainfrom
Open
docs: clarify Expo-only requirement and add peer dependency table#12blick wants to merge 2 commits intocookie-information:mainfrom
blick wants to merge 2 commits intocookie-information:mainfrom
Conversation
Add a prominent notice that the package is an Expo module and does not support bare React Native projects. Add a Requirements section listing the peer dependencies (expo, react-native, react) with their required versions, and a post-install note about running expo prebuild.
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.
Summary
expo,react-native,react) with their required versionsexpo prebuildbefore running the appMotivation
The README currently describes this as a generic React Native package, which may lead developers to try installing it in bare React Native projects where it will not work. Making the Expo dependency explicit upfront avoids confusion.