docs: expand README with requirements and full API reference - #45
Merged
Merged
Conversation
Bring the README in line with the shipped 1.2.3 package: * Bump the install snippet from ^1.2.1 to ^1.2.3. * Add a requirements table (Flutter 3.44, Dart 3.12, Android minSdk 21 / compileSdk 34 / JVM 17, iOS 11.0) and note the SPM-first iOS setup with CocoaPods still supported. * Replace the per-platform copy-paste blocks with an API table covering every member, including the previously undocumented isDebugged, and spell out that platform-specific members throw MissingPluginException on the other platform. * Document checkForIssues and each JailbreakIssue value with per-platform support, derived from the native implementations. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
prongbang
force-pushed
the
docs/readme-api-reference
branch
from
August 15, 2026 06:33
9d3b29c to
ee2b163
Compare
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.
Bring the README in line with the shipped 1.2.3 package: