docs: expand README usage and sync CHANGELOG with 2.0 features - #174
Merged
Conversation
README rewrite documents previously-undocumented 2.0 capabilities:
scheduled notifications (scheduledAt), action buttons with inline text
input (NotificationAction / remote_input), notification images, the full
notify {} builder DSL, permission helpers, and channel/sound config.
Adds a feature/platform support matrix.
CHANGELOG: add scheduling, action buttons, and the builder DSL to the
2.0.0 "Added" list (PR #162 landed after v1.6.1, so they ship first in
2.0.0); fix the stale firebase-ios-sdk pin (12.1.0 -> 12.14.0) to match
the build script.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
What
The README didn't cover several features that ship in 2.0.0 (notably notification scheduling). This rewrites the Usage section and syncs the CHANGELOG.
README
scheduledAt(epoch millis) builder property; android (AlarmManager) + iOS (UNTimeIntervalNotificationTrigger), shown immediately on desktop/web.remove(id)cancels a pending schedule.NotificationAction(actionsbuilder property), incl. inline text input (allowsTextInput/inputLabel, result underremote_input).notify {}builder DSL — table of every property +payload {}sub-DSL; quicknotify(...)overloads.NotificationImage.Url/.File.KMPNotifier.permissionUtil+ AndroidComponentActivity.permissionUtil()flow.NotificationChannelData(soundUri), iOSnotificationSoundName.scheduleSimple(deprecated no-op shim) and@InternalKMPNotifierApitypes.CHANGELOG
v1.6.1, so these ship first in 2.0.0.firebase-ios-sdkpin12.1.0→12.14.0to matchkmpnotifier-push-firebase/build.gradle.kts.Notes
Docs-only change — no code/API touched, so no
apiDumpneeded.🤖 Generated with Claude Code