Skip to content

Commit

Permalink
Added some details to the README.
Browse files Browse the repository at this point in the history
  • Loading branch information
larryaasen committed Nov 7, 2023
1 parent 0a0826d commit a8f9cad
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,14 @@ will become more likely that users on other app stores need to be nagged about u
The widgets come in two flavors: alert or card. The [UpgradeAlert](#alert-example) widget is used to display the
popup alert prompt, and the [UpgradeCard](#card-example) widget is used to display the inline material design card.

There are three buttons displayed to the user: IGNORE, LATER, and UPDATE NOW.

Tapping IGNORE prevents the alert from being displayed again for that version.

Tapping the LATER button just closes the alert allowing the alert to be displayed sometime in the future.

Tapping the UPDATE NOW button takes the user to the App Store (iOS) or Google Play Store (Android) where the user is required to initiate the update process.

## Alert Example

Just wrap your body widget in the `UpgradeAlert` widget, and it will handle the rest.
Expand Down

0 comments on commit a8f9cad

Please sign in to comment.