Skip to content

Commit

Permalink
Replace App Store version with binary version in docs (#1614)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandergoncharov-zz authored Jun 18, 2019
1 parent 7cf8ef1 commit c39fa0d
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions CodePush.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ async function checkForUpdate(deploymentKey = null, handleBinaryVersionMismatchC
* then we want to use its package hash to determine whether a new
* release has been made on the server. Otherwise, we only need
* to send the app version to the server, since we are interested
* in any updates for current app store version, regardless of hash.
* in any updates for current binary version, regardless of hash.
*/
let queryPackage;
if (localPackage) {
Expand All @@ -58,7 +58,7 @@ async function checkForUpdate(deploymentKey = null, handleBinaryVersionMismatchC
* ----------------------------------------------------------------
* 1) The server said there isn't an update. This is the most common case.
* 2) The server said there is an update but it requires a newer binary version.
* This would occur when end-users are running an older app store version than
* This would occur when end-users are running an older binary version than
* is available, and CodePush is making sure they don't get an update that
* potentially wouldn't be compatible with what they are running.
* 3) The server said there is an update, but the update's hash is the same as
Expand Down
2 changes: 1 addition & 1 deletion docs/api-ios.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The `CodePush` class' methods can be thought of as composite resolvers which alw

2. As soon as you begin releasing CodePush updates, your end-users will get the JS bundle that represents the latest release for the configured deployment. This is the behavior that allows you to iterate beyond what you shipped to the store.

3. As soon as you release an update to the app store (like `1.1.0`), and your end-users update it, they will once again get the JS bundle that is contained within the binary. This behavior ensures that CodePush updates that targetted a previous app store version aren't used (since we don't know if they would work), and your end-users always have a working version of your app.
3. As soon as you release an update to the app store (like `1.1.0`), and your end-users update it, they will once again get the JS bundle that is contained within the binary. This behavior ensures that CodePush updates that targetted a previous binary version aren't used (since we don't know if they would work), and your end-users always have a working version of your app.

4. Repeat #2 and #3 as the CodePush releases and app store releases continue on into infinity (and beyond?)

Expand Down
2 changes: 1 addition & 1 deletion ios/CodePush/CodePush.h
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
/*
* This method allows the version of the app's binary interface
* to be specified, which would otherwise default to the
* App Store version of the app.
* binary version of the app.
*/
+ (void)overrideAppVersion:(NSString *)appVersion;

Expand Down

0 comments on commit c39fa0d

Please sign in to comment.