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
{{ message }}
This repository was archived by the owner on May 20, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+20-8Lines changed: 20 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ In order to ensure that your end users always have a functioning version of your
40
40
41
41
Once you've followed the general-purpose ["getting started"](http://codepush.tools/docs/getting-started.html) instructions for setting up your CodePush account, you can start CodePush-ifying your React Native app by running the following command from within your app's root directory:
42
42
43
-
```
43
+
```shell
44
44
npm install --save react-native-code-push
45
45
```
46
46
@@ -79,26 +79,38 @@ Once your Xcode project has been setup to build/link the CodePush plugin, you ne
79
79
80
80
1. Open up the `AppDelegate.m` file, and add an import statement for the CodePush headers:
81
81
82
-
```
82
+
```objective-c
83
83
#import"CodePush.h"
84
84
```
85
85
86
86
2. Find the following line of code, which loads your JS Bundle from the app binary for production releases:
This change configures your app to always load the most recent version of your app's JS bundle. On the first launch, this will correspond to the file that was compiled with the app. However, after an update has been pushed via CodePush, this will return the location of the most recently installed update.
99
99
100
100
*NOTE: The `bundleURL` method assumes your app's JS bundle is named `main.jsbundle`. If you have configured your app to use a different file name, simply call the `bundleURLForResource:` method (which assumes you're using the `.jsbundle` extension) or `bundleURLForResource:withExtension:` method instead, in order to overwrite that default behavior*
101
101
102
+
Typically, you're only going to want to use CodePush to resolve your JS bundle location within release builds, and therefore, we recommend using the `DEBUG` pre-processor macro to dynamically switch between using the packager server and CodePush, depending on whether you are debugging or not. This will make it much simpler to ensure you get the right behavior you want in production, while still being able to use the Chrome Dev Tools, live reload, etc. at debug-time.
To let the CodePush runtime know which deployment it should query for updates against, perform the following steps:
103
115
104
116
1. Open your app's `Info.plist` file and add a new entry named `CodePushDeploymentKey`, whose value is the key of the deployment you want to configure this app against (e.g. the key for the `Staging` deployment for the `FooBar` app). You can retrieve this value by running `code-push deployment ls <appName>` in the CodePush CLI, and copying the value of the `Deployment Key` column which corresponds to the deployment you want to use (see below). Note that using the deployment's name (e.g. Staging) will not work. That "friendly name" is intended only for authenticated management usage from the CLI, and not for public consumption within your app.
@@ -195,13 +207,13 @@ The simplest way to do this is to perform the following in your app's root compo
195
207
196
208
1. Import the JavaScript module for CodePush:
197
209
198
-
```
210
+
```javascript
199
211
import CodePush from "react-native-code-push";
200
212
```
201
213
202
214
2. Call the `sync` method from within the `componentDidMount` lifecycle event, to initiate a background update on each app start:
203
215
204
-
```
216
+
```javascript
205
217
CodePush.sync();
206
218
```
207
219
@@ -219,7 +231,7 @@ Once your app has been configured and distributed to your users, and you've made
@@ -238,7 +250,7 @@ If you are using the new React Native [assets system](https://facebook.github.io
238
250
239
251
2. When calling `react-native bundle`, specify that your assets and JS bundle go into the directory you created in #1, and that you want a non-dev build for your respective platform and entry file. For example, assuming you called this directory "release", you could run the following command:
0 commit comments