You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
#### [Sign up With Source Push](https://console.srcpush.com/register) to use CodePush SDK
1
+
#### [Sign up With Source Push](https://console.srcpush.com/register) to use Source Push SDK
2
2
3
3
# React Native SDK for Source Push (CodePush compatible service)
4
4
5
-
This plugin provides client-side integration for the [CodePush service](https://srcpush.com/), allowing you to easily add a dynamic update experience to your React Native app(s).
5
+
This plugin provides client-side integration for the [Source Push service](https://srcpush.com/), allowing you to easily add a dynamic update experience to your React Native app(s).
6
6
7
7
<!-- React Native Catalog -->
8
8
@@ -34,20 +34,20 @@ This plugin provides client-side integration for the [CodePush service](https://
34
34
35
35
A React Native app is composed of JavaScript files and any accompanying [images](https://reactnative.dev/docs/image), which are bundled together by the [metro bundler](https://github.com/facebook/metro) and distributed as part of a platform-specific binary (i.e. an `.ipa` or `.apk` file). Once the app is released, updating either the JavaScript code (e.g. making bug fixes, adding new features) or image assets, requires you to recompile and redistribute the entire binary, which of course, includes any review time associated with the store(s) you are publishing to.
36
36
37
-
The CodePush plugin helps get product improvements in front of your end users instantly, by keeping your JavaScript and images synchronized with updates you release to the CodePush server. This way, your app gets the benefits of an offline mobile experience, as well as the "web-like" agility of side-loading updates as soon as they are available. It's a win-win!
37
+
The Source Push plugin helps get product improvements in front of your end users instantly, by keeping your JavaScript and images synchronized with updates you release to the Source Push server. This way, your app gets the benefits of an offline mobile experience, as well as the "web-like" agility of side-loading updates as soon as they are available. It's a win-win!
38
38
39
-
In order to ensure that your end users always have a functioning version of your app, the CodePush plugin maintains a copy of the previous update, so that in the event that you accidentally push an update which includes a crash, it can automatically roll back. This way, you can rest assured that your newfound release agility won't result in users becoming blocked before you have a chance to roll back on the server. It's a win-win-win!
39
+
In order to ensure that your end users always have a functioning version of your app, the Source Push plugin maintains a copy of the previous update, so that in the event that you accidentally push an update which includes a crash, it can automatically roll back. This way, you can rest assured that your newfound release agility won't result in users becoming blocked before you have a chance to roll back on the server. It's a win-win-win!
40
40
41
-
*Note: Any product changes which touch native code (e.g. modifying your `AppDelegate.m`/`MainActivity.java` file, adding a new plugin) cannot be distributed via CodePush, and therefore, must be updated via the appropriate store(s).*
41
+
*Note: Any product changes which touch native code (e.g. modifying your `AppDelegate.m`/`MainActivity.java` file, adding a new plugin) cannot be distributed via Source Push, and therefore, must be updated via the appropriate store(s).*
42
42
43
43
## Supported React Native platforms
44
44
45
45
* iOS (7+)
46
46
* Android (4.1+) on TLS 1.2 compatible devices
47
47
48
-
We try our best to maintain backwards compatibility of our plugin with previous versions of React Native, but due to the nature of the platform, and the existence of breaking changes between releases, it is possible that you need to use a specific version of the CodePush plugin in order to support the exact version of React Native you are using. The following table outlines which CodePush plugin versions officially support the respective React Native versions:
48
+
We try our best to maintain backwards compatibility of our plugin with previous versions of React Native, but due to the nature of the platform, and the existence of breaking changes between releases, it is possible that you need to use a specific version of the Source Push plugin in order to support the exact version of React Native you are using. The following table outlines which Source Push plugin versions officially support the respective React Native versions:
| <v0.76 | Use [microsoft/code-push-react-native](https://github.com/microsoft/react-native-code-push)|
53
53
| v0.76, v0.77, 0.78 | v1.0+ *(Support both New and Old Architectures)*|
@@ -56,7 +56,7 @@ We work hard to respond to new RN releases, but they do occasionally break us. W
56
56
57
57
### Supported Components
58
58
59
-
When using the React Native assets system (i.e. using the `require("./foo.png")` syntax), the following list represents the set of core components (and props) that support having their referenced images and videos updated via CodePush:
59
+
When using the React Native assets system (i.e. using the `require("./foo.png")` syntax), the following list represents the set of core components (and props) that support having their referenced images and videos updated via Source Push:
The following list represents the set of components (and props) that don't currently support their assets being updated via CodePush, due to their dependency on static images and videos (i.e. using the `{ uri: "foo" }` syntax):
70
+
The following list represents the set of components (and props) that don't currently support their assets being updated via Source Push, due to their dependency on static images and videos (i.e. using the `{ uri: "foo" }` syntax):
As new core components are released, which support referencing assets, we'll update this list to ensure users know what exactly they can expect to update using CodePush.
77
+
As new core components are released, which support referencing assets, we'll update this list to ensure users know what exactly they can expect to update using Source Push.
78
78
79
-
*Note: CodePush only works with Video components when using `require` in the source prop. For example:*
79
+
*Note: Source Push only works with Video components when using `require` in the source prop. For example:*
80
80
81
81
```javascript
82
82
<Video source={require("./foo.mp4")} />
83
83
```
84
84
85
85
## Getting Started
86
86
87
-
After you've created an account on [Source Push](https://console.srcpush.com/register), you can start CodePush-ifying your React Native app by running the following command from within your app's root directory:
87
+
After you've created an account on [Source Push](https://console.srcpush.com/register), you can start Source Push-ifying your React Native app by running the following command from within your app's root directory:
As with all other React Native plugins, the integration experience is different for iOS and Android, so perform the following setup steps depending on which platform(s) you are targeting. Note, if you are targeting both platforms it is recommended to create separate CodePush applications for each platform.
93
+
As with all other React Native plugins, the integration experience is different for iOS and Android, so perform the following setup steps depending on which platform(s) you are targeting. Note, if you are targeting both platforms it is recommended to create separate Source Push applications for each platform.
94
94
95
95
*NOTE: This guide assumes you have used the `@react-native-community/cli init` command to initialize your React Native project.*
96
96
@@ -101,13 +101,13 @@ Then continue with installing the native module
101
101
102
102
## Plugin Usage
103
103
104
-
With the CodePush plugin downloaded and linked, and your app asking CodePush where to get the right JS bundle from, the only thing left is to add the necessary code to your app to control the following policies:
104
+
With the Source Push plugin downloaded and linked, and your app asking Source Push where to get the right JS bundle from, the only thing left is to add the necessary code to your app to control the following policies:
105
105
106
106
1. When (and how often) to check for an update? (for example app start, in response to clicking a button in a settings page, periodically at some fixed interval)
107
107
108
108
2. When an update is available, how to present it to the end user?
109
109
110
-
The simplest way to do this is to "CodePush-ify" your app's root component. To do so, you can choose one of the following two options:
110
+
The simplest way to do this is to "Source Push-ify" your app's root component. To do so, you can choose one of the following two options:
111
111
112
112
***Option 1: Wrap your root component with the `codePush` higher-order component:**
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
3
+
Source Push takes the security of our software products and services seriously.
6
4
7
-
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below.
5
+
If you believe you have found a security vulnerability in this repository, please report it to us as described below.
8
6
9
7
## Reporting Security Issues
10
8
11
9
**Please do not report security vulnerabilities through public GitHub issues.**
12
10
13
-
Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
14
-
15
-
If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
11
+
Instead, please report them to us via email at [security@srcpush.com](mailto:security@srcpush.com).
16
12
17
-
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
13
+
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message.
18
14
19
15
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
20
16
@@ -26,16 +22,4 @@ Please include the requested information listed below (as much as you can provid
26
22
* Proof-of-concept or exploit code (if possible)
27
23
* Impact of the issue, including how an attacker might exploit the issue
28
24
29
-
This information will help us triage your report more quickly.
30
-
31
-
If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs.
32
-
33
-
## Preferred Languages
34
-
35
-
We prefer all communications to be in English.
36
-
37
-
## Policy
38
-
39
-
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
40
-
41
-
<!-- END MICROSOFT SECURITY.MD BLOCK -->
25
+
This information will help us triage your report more quickly.
0 commit comments