Skip to content

Commit 6fe99df

Browse files
committed
Update documentation to reflect Source Push branding and SDK references
1 parent c511008 commit 6fe99df

7 files changed

Lines changed: 24 additions & 24 deletions

File tree

.github/ISSUE_TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ What actually happens?
1616

1717
### Reproducible Demo
1818

19-
* Download https://github.com/microsoft/react-native-code-push/archive/master.zip and unzip. From `Examples` folder run `node create-app.js appName react-native@0.71.19 react-native-code-push@9.0.1` command to generate plain CodePushified React Native app. Please see description on top of `create-app.js` file content if needed
19+
* Download https://github.com/srcpush/react-native-code-push/archive/main.zip and unzip. From the `Examples` folder run `node create-app.js appName react-native@0.71.19 @srcpush/react-native-code-push@1.1.5` to generate a plain Source Push-enabled React Native app. See the description at the top of `create-app.js` if needed.
2020
* If you can't reproduce the bug on it, provide us as much info as possible about your project
2121

2222
### Environment
2323

24-
* react-native-code-push version:
24+
* @srcpush/react-native-code-push version:
2525
* react-native version:
2626
* iOS/Android/Windows version:
2727
* Does this reproduce on a debug build or release build?

docs/api-android.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Resource Configuration
22

3-
Since `autolinking` uses `react-native.config.js` to link plugins, constructors are specified in that file. But you can override custom variables to manage the Source Push plugin by placing these values in string resources.
3+
Since `autolinking` uses `react-native.config.js` to link plugins, constructors are specified in that file. But you can override custom variables to manage the Source Push SDK by placing these values in string resources.
44

55
- **Public Key** - used for bundle verification in the Code Signing Feature. Please refer to [Code Signing](setup-android.md#code-signing-setup) section for more details about the Code Signing Feature.
66
To set the public key, you should add the content of the public key to `strings.xml` with name `CodePushPublicKey`. Source Push automatically gets this property and enables the Code Signing feature. For example:

docs/api-js.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## API Reference
22

3-
The Source Push plugin is made up of two components:
3+
The Source Push SDK is made up of two components:
44

55
1. A JavaScript module, which can be imported/required, and allows the app to interact with the service during runtime (for example check for updates, inspect the metadata about the currently running app update).
66

@@ -10,7 +10,7 @@ The following sections describe the shape and behavior of these APIs in detail:
1010

1111
### JavaScript API Reference
1212

13-
When you require `react-native-code-push`, the module object provides the following top-level methods in addition to the root-level [component decorator](#codepush):
13+
When you require `@srcpush/react-native-code-push`, the module object provides the following top-level methods in addition to the root-level [component decorator](#codepush):
1414

1515
* [allowRestart](#codepushallowrestart): Re-allows programmatic restarts to occur as a result of an update being installed, and optionally, immediately restarts the app if a pending update had attempted to restart the app while restarts were disallowed. This is an advanced API and is only necessary if your app explicitly disallowed restarts via the `disallowRestart` method.
1616

@@ -128,7 +128,7 @@ The `codePush` decorator accepts an "options" object that allows you to customiz
128128

129129
* __minimumBackgroundDuration__ *(Number)* - Specifies the minimum number of seconds that the app needs to have been in the background before restarting the app. This property only applies to updates which are installed using `InstallMode.ON_NEXT_RESUME` or `InstallMode.ON_NEXT_SUSPEND`, and can be useful for getting your update in front of end users sooner, without being too obtrusive. Defaults to `0`, which has the effect of applying the update immediately after a resume or unless the app suspension is long enough to not matter, regardless how long it was in the background.
130130

131-
* __updateDialog__ *(UpdateDialogOptions)* - An "options" object used to determine whether a confirmation dialog should be displayed to the end user when an update is available, and if so, what strings to use. Defaults to `null`, which has the effect of disabling the dialog completely. Setting this to any truthy value will enable the dialog with the default strings, and passing an object to this parameter allows enabling the dialog as well as overriding one or more of the default strings. Before enabling this option within an App Store-distributed app, please refer to [this note](https://github.com/microsoft/react-native-code-push#app-store).
131+
* __updateDialog__ *(UpdateDialogOptions)* - An "options" object used to determine whether a confirmation dialog should be displayed to the end user when an update is available, and if so, what strings to use. Defaults to `null`, which has the effect of disabling the dialog completely. Setting this to any truthy value will enable the dialog with the default strings, and passing an object to this parameter allows enabling the dialog as well as overriding one or more of the default strings. Before enabling this option within an App Store-distributed app, please refer to [this note](https://github.com/srcpush/react-native-code-push#app-store).
132132

133133
The following list represents the available options and their defaults:
134134

@@ -162,7 +162,7 @@ Called when the sync process moves from one stage to another in the overall upda
162162

163163
##### codePushDownloadDidProgress (event hook)
164164

165-
Called periodically when an available update is being downloaded from the Source Push server. The method is called with a `DownloadProgress` object, which contains the following two properties:
165+
Called periodically when an available update is being downloaded from the Source Push service. The method is called with a `DownloadProgress` object, which contains the following two properties:
166166

167167
* __totalBytes__ *(Number)* - The total number of bytes expected to be received for this update (i.e. the size of the set of files which changed from the previous release).
168168

@@ -248,9 +248,9 @@ Temporarily disallows programmatic restarts to occur as a result of either of fo
248248

249249
After calling this method, any calls to `sync` would still be allowed to check for an update, download it and install it, but an attempt to restart the app would be queued until `allowRestart` is called. This way, the restart request is captured and can be "flushed" whenever you want to allow it to occur.
250250

251-
This is an advanced API, and is primarily useful when individual components within your app (like an onboarding process) need to ensure that no end-user interruptions can occur during their lifetime, while continuing to allow the app to keep syncing with the Source Push server at its own pace and using whatever install modes are appropriate. This has the benefit of allowing the app to discover and download available updates as soon as possible, while also preventing any disruptions during key end-user experiences.
251+
This is an advanced API, and is primarily useful when individual components within your app (like an onboarding process) need to ensure that no end-user interruptions can occur during their lifetime, while continuing to allow the app to keep syncing with the Source Push service at its own pace and using whatever install modes are appropriate. This has the benefit of allowing the app to discover and download available updates as soon as possible, while also preventing any disruptions during key end-user experiences.
252252

253-
As an alternative, you could also choose to simply use `InstallMode.ON_NEXT_RESTART` whenever calling `sync` (which will never attempt to programmatically restart the app), and then explicity calling `restartApp` at points in your app that you know it is "safe" to do so. `disallowRestart` provides an alternative approach to this when the code that synchronizes with the CodePush server is separate from the code/components that want to enforce a no-restart policy.
253+
As an alternative, you could also choose to simply use `InstallMode.ON_NEXT_RESTART` whenever calling `sync` (which will never attempt to programmatically restart the app), and then explicity calling `restartApp` at points in your app that you know it is "safe" to do so. `disallowRestart` provides an alternative approach to this when the code that synchronizes with the Source Push service is separate from the code/components that want to enforce a no-restart policy.
254254

255255
Example Usage:
256256

@@ -456,7 +456,7 @@ In addition to the options, the `sync` method also accepts several optional func
456456

457457
* __syncStatusChangedCallback__ *((syncStatus: Number) => void)* - Called when the sync process moves from one stage to another in the overall update process. The method is called with a status code which represents the current state, and can be any of the [`SyncStatus`](#syncstatus) values.
458458

459-
* __downloadProgressCallback__ *((progress: DownloadProgress) => void)* - Called periodically when an available update is being downloaded from the CodePush server. The method is called with a `DownloadProgress` object, which contains the following two properties:
459+
* __downloadProgressCallback__ *((progress: DownloadProgress) => void)* - Called periodically when an available update is being downloaded from the Source Push service. The method is called with a `DownloadProgress` object, which contains the following two properties:
460460

461461
* __totalBytes__ *(Number)* - The total number of bytes expected to be received for this update (i.e. the size of the set of files which changed from the previous release).
462462

@@ -489,7 +489,7 @@ codePush.sync({ updateDialog: true },
489489

490490
This method returns a `Promise` which is resolved to a `SyncStatus` code that indicates why the `sync` call succeeded. This code can be one of the following `SyncStatus` values:
491491

492-
* __codePush.SyncStatus.UP_TO_DATE__ *(0)* - The app is up-to-date with the CodePush server.
492+
* __codePush.SyncStatus.UP_TO_DATE__ *(0)* - The app is up-to-date with the Source Push service.
493493

494494
* __codePush.SyncStatus.UPDATE_IGNORED__ *(2)* - The app had an optional update which the end user chose to ignore. (This is only applicable when the `updateDialog` is used)
495495

@@ -505,7 +505,7 @@ The `checkForUpdate` and `getUpdateMetadata` methods return `Promise` objects, t
505505

506506
* [LocalPackage](#localpackage): Represents a downloaded update that is either already running, or has been installed and is pending an app restart.
507507

508-
* [RemotePackage](#remotepackage): Represents an available update on the CodePush server that hasn't been downloaded yet.
508+
* [RemotePackage](#remotepackage): Represents an available update on the Source Push service that hasn't been downloaded yet.
509509

510510
##### LocalPackage
511511

@@ -519,7 +519,7 @@ Contains details about an update that has been downloaded locally or already ins
519519
- __isFirstRun__: Indicates whether this is the first time the update has been run after being installed. This is useful for determining whether you would like to show a "What's New?" UI to the end user after installing an update. *(Boolean)*
520520
- __isMandatory__: Indicates whether the update is considered mandatory. This is the value that was specified in the CLI when the update was released. *(Boolean)*
521521
- __isPending__: Indicates whether this update is in a "pending" state. When `true`, that means the update has been downloaded and installed, but the app restart needed to apply it hasn't occurred yet, and therefore, it's changes aren't currently visible to the end-user. *(Boolean)*
522-
- __label__: The internal label automatically given to the update by the CodePush server, such as `v5`. This value uniquely identifies the update within it's deployment. *(String)*
522+
- __label__: The internal label automatically given to the update by the Source Push service, such as `v5`. This value uniquely identifies the update within it's deployment. *(String)*
523523
- __packageHash__: The SHA hash value of the update. *(String)*
524524
- __packageSize__: The size of the code contained within the update, in bytes. *(Number)*
525525

@@ -529,7 +529,7 @@ Contains details about an update that has been downloaded locally or already ins
529529

530530
##### RemotePackage
531531

532-
Contains details about an update that is available for download from the CodePush server. You get a reference to an instance of this object by calling the `checkForUpdate` method when an update is available. If you are using the `sync` API, you don't need to worry about the `RemotePackage`, since it will handle the download and installation process automatically for you.
532+
Contains details about an update that is available for download from the Source Push service. You get a reference to an instance of this object by calling the `checkForUpdate` method when an update is available. If you are using the `sync` API, you don't need to worry about the `RemotePackage`, since it will handle the download and installation process automatically for you.
533533

534534
###### Properties
535535

@@ -576,9 +576,9 @@ This enum is provided to the `syncStatusChangedCallback` function that can be pa
576576
* __codePush.SyncStatus.UPDATE_IGNORED__ *(2)* - The app has an optional update, which the end user chose to ignore. (This is only applicable when the `updateDialog` is used)
577577
* __codePush.SyncStatus.UNKNOWN_ERROR__ *(3)* - The sync operation encountered an unknown error.
578578
* __codePush.SyncStatus.SYNC_IN_PROGRESS__ *(4)* - There is an ongoing `sync` operation running which prevents the current call from being executed.
579-
* __codePush.SyncStatus.CHECKING_FOR_UPDATE__ *(5)* - The CodePush server is being queried for an update.
579+
* __codePush.SyncStatus.CHECKING_FOR_UPDATE__ *(5)* - The Source Push service is being queried for an update.
580580
* __codePush.SyncStatus.AWAITING_USER_ACTION__ *(6)* - An update is available, and a confirmation dialog was shown to the end user. (This is only applicable when the `updateDialog` is used)
581-
* __codePush.SyncStatus.DOWNLOADING_PACKAGE__ *(7)* - An available update is being downloaded from the CodePush server.
581+
* __codePush.SyncStatus.DOWNLOADING_PACKAGE__ *(7)* - An available update is being downloaded from the Source Push service.
582582
* __codePush.SyncStatus.INSTALLING_UPDATE__ *(8)* - An available update was downloaded and is about to be installed.
583583
584584
##### UpdateState

docs/multi-deployment-testing-android.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> NOTE
44
>
5-
> Complete demo configured with "multi-deployment testing" feature is [here](https://github.com/microsoft/react-native-code-push/files/1314118/rncp1004.zip).
5+
> Complete demo configured with "multi-deployment testing" feature is [here](https://github.com/srcpush/react-native-code-push/files/1314118/rncp1004.zip).
66
77
The [Android Gradle plugin](https://google.github.io/android-gradle-dsl/current/index.html) allows you to define custom config settings for each "build type" (like debug, release). This mechanism allows you to easily configure your debug builds to use your Source Push staging deployment key and your release builds to use your Source Push production deployment key.
88

docs/multi-deployment-testing-ios.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
>
55
> Complete demos configured with "multi-deployment testing" feature are [here]:
66
>
7-
> * **without using cocoa pods**: [link](https://github.com/microsoft/react-native-code-push/files/1259957/rncp976.copy.zip)
8-
> * **using cocoa pods**: [link](https://github.com/microsoft/react-native-code-push/files/1172217/rncp893.copy.zip)
7+
> * **without using cocoa pods**: [link](https://github.com/srcpush/react-native-code-push/files/1259957/rncp976.copy.zip)
8+
> * **using cocoa pods**: [link](https://github.com/srcpush/react-native-code-push/files/1172217/rncp893.copy.zip)
99
1010
Xcode allows you to define custom build settings for each "configuration" (like debug, release), which can then be referenced as the value of keys within the `Info.plist` file (like the `CodePushDeploymentKey` setting). This mechanism allows you to easily configure your builds to produce binaries, which are configured to synchronize with different Source Push deployments.
1111

@@ -55,6 +55,6 @@ And that's it! Now when you run or build your app, your staging builds will auto
5555

5656
*NOTE: CocoaPods users may need to run `pod install` before building with their new release configuration.*
5757

58-
*Note: If you encounter the error message `ld: library not found for ...`, please consult [this issue](https://github.com/microsoft/react-native-code-push/issues/426) for a possible solution.*
58+
*Note: If you encounter the error message `ld: library not found for ...`, please consult [this issue](https://github.com/srcpush/react-native-code-push/issues/426) for a possible solution.*
5959

6060
Additionally, if you want to give them seperate names and/or icons, you can modify the `Product Bundle Identifier`, `Product Name` and `Asset Catalog App Icon Set Name` build settings, which will allow your staging builds to be distinguishable from release builds when installed on the same device.

docs/setup-ios.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## iOS Setup
22

3-
Once you've acquired the Source Push plugin, you need to integrate it into the Xcode project of your React Native app and configure it correctly. To do this, take the following steps:
3+
Once you've acquired the Source Push SDK, you need to integrate it into the Xcode project of your React Native app and configure it correctly. To do this, take the following steps:
44

55
### Plugin Installation and Configuration for React Native 0.76 version and above (iOS)
66

@@ -92,7 +92,7 @@ That "friendly name" is intended only for authenticated management usage from th
9292

9393
### HTTP exception domains configuration (iOS)
9494

95-
Source Push plugin makes HTTPS requests to the following domains:
95+
The Source Push SDK makes HTTPS requests to the following domains:
9696

9797
- api.srcpush.com
9898
- blob.srcpush.com

docs/setup-windows.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Windows Setup
22

3-
Once you've acquired the Source Push plugin, you need to integrate it into the Visual Studio project of your React Native app and configure it correctly. To do this, take the following steps:
3+
Once you've acquired the Source Push SDK, you need to integrate it into the Visual Studio project of your React Native app and configure it correctly. To do this, take the following steps:
44

55
### Plugin Installation and Configuration for React Native Windows 0.63.6 version and above
66

@@ -66,7 +66,7 @@ protected override void OnLaunched(LaunchActivatedEventArgs e)
6666

6767
![Add Project](https://cloud.githubusercontent.com/assets/116461/14467164/ddf6312e-008e-11e6-8a10-44a8b44b5dfc.PNG)
6868

69-
3. Browse to the `node_modules\react-native-code-push\windows` directory, select the `CodePush.csproj` file and click `OK`
69+
3. Browse to the `node_modules\@srcpush\react-native-code-push\windows` directory, select the `CodePush.csproj` file and click `OK`
7070

7171
4. Back in the `Solution Explorer`, right-click the project node that is named after your app, and select the `Add -> Reference...` menu item
7272

0 commit comments

Comments
 (0)