Merge pull request #36 from phimage/fix-readme

Readme incorrectly documented showPrompt methods
This commit is contained in:
Matt Coneybeare
2015-12-15 09:19:18 -05:00

View File

@@ -275,9 +275,9 @@ Read more about these functions below in the [Should-Prompt Closure](#should-pro
Armchair.showPrompt()
`showPrompt(ifNecessary: Bool)` tells Armchair to show the review prompt alert if all restrictions have been met. The prompt will be shown if all restrictions are met, there is an internet connection available, the user hasn't declined to rate, hasn't rated current version, and you are tracking new versions. You could call to show the prompt, for instance, in the case of some special event in your app like a user login.
`showPromptIfNecessary()` tells Armchair to show the review prompt alert if all restrictions have been met. The prompt will be shown if all restrictions are met, there is an internet connection available, the user hasn't declined to rate, hasn't rated current version, and you are tracking new versions. You could call to show the prompt, for instance, in the case of some special event in your app like a user login.
Armchair.showPrompt(ifNecessary: Bool)
Armchair.showPromptIfNecessary()
The `reviewURLString()` function is the review URL string, generated by substituting the `appID`, `affiliateCode` and `affiliateCampaignCode` into the template URL for the current platform.