From 18e0ebe1e60008cb95e2873f010595b7a3325e4d Mon Sep 17 00:00:00 2001 From: Jonathan Carter Date: Fri, 12 Feb 2016 12:10:04 -0800 Subject: [PATCH] Version bump and doc updates --- CodePush.podspec | 2 +- README.md | 9 ++++++++- package.json | 2 +- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/CodePush.podspec b/CodePush.podspec index 0485fd7..a922065 100644 --- a/CodePush.podspec +++ b/CodePush.podspec @@ -1,7 +1,7 @@ Pod::Spec.new do |s| s.name = 'CodePush' - s.version = '1.7.2-beta' + s.version = '1.7.3-beta' s.summary = 'React Native plugin for the CodePush service' s.author = 'Microsoft Corporation' s.license = 'MIT' diff --git a/README.md b/README.md index c527897..6ac429c 100644 --- a/README.md +++ b/README.md @@ -399,7 +399,14 @@ codePush.getCurrentPackage(): Promise; Retrieves the metadata about the currently installed "package" (e.g. description, installation time). This can be useful for scenarios such as displaying a "what's new?" dialog after an update has been applied or checking whether there is a pending update that is waiting to be applied via a resume or restart. -This method returns a `Promise` which resolves to the [`LocalPackage`](#localpackage) instance that represents the currently running update. +This method returns a `Promise` which resolves to one of two possible values: + +1. `null` if the app is currently running the JS bundle from the binary and not a CodePush update. This occurs in the following scenarios: + + 1. The end-user installed the app binary and has yet to install a CodePush update + 1. The end-user installed an update of the binary (e.g. from the store), which cleared away the old CodePush updates, and gave precedence back to the JS binary in the binary. + +2. A [`LocalPackage`](#localpackage) instance which represents the metadata for the currently running CodePush update. Example Usage: diff --git a/package.json b/package.json index 1f655b8..8b886b0 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "react-native-code-push", - "version": "1.7.2-beta", + "version": "1.7.3-beta", "description": "React Native plugin for the CodePush service", "main": "CodePush.js", "homepage": "https://microsoft.github.io/code-push",