Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.

Commit 95c81df

Browse files
committed
Further doc updates
1 parent aa395d5 commit 95c81df

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ This plugin provides client-side integration for the [CodePush service](https://
44

55
## How does it work?
66

7-
A React Native app is composed of a `.jsbundle` file which is generated by the packager and then distributed as part of your app's binary (the `.ipa` or `.apk` file). Traditionally, in order to update any of the JavaScript code, you'd need to recompile and re-distribute the binary, which includes any review time for the respective store(s) you are publishing to.
7+
A React Native app is composed of a `.jsbundle` file which is generated by the packager and distributed as part of your app's binary (the `.ipa` or `.apk` file). Traditionally, in order to update any of the JavaScript code, you'd need to recompile and re-distribute the binary, which includes any review time associated with the respective store(s) you are publishing to.
88

9-
The CodePush plugin for React Native helps simplify and speed up the process of getting JavaScript changes to your end-users by synchronizing the `.jsbundle` file with updates you release to the CodePush server. This way, you get the benefit of an offline, mobile experience, as well as "web-like" agility of side-loading updates as soon as they are made available.
9+
The CodePush plugin for React Native helps simplify and speed up the process of getting JavaScript changes to your end-users by keeping the `.jsbundle` file synchronized with updates that are released 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.
1010

1111
## Supported React Native platforms
1212

1313
- iOS
1414
- Coming soon: Android (Try it out on [this branch](https://github.com/Microsoft/react-native-code-push/tree/first-check-in-for-android))
1515

16-
## Plugin Acquisition
16+
## Getting Started
1717

18-
To get started, you first need to acquire the React Native CodePush plugin by running the following command within your app's root directory:
18+
To get started, you first need to acquire the React Native CodePush plugin by running the following command from within your app's root directory:
1919

2020
```
2121
npm install --save react-native-code-push
@@ -42,7 +42,7 @@ Add a new value, `$(SRCROOT)/../node_modules/react-native-code-push` and select
4242

4343
## Plugin Configuration
4444

45-
Once your Xcode project has been setup to build/link the CodePush plugin, you need to configure your app to consult CodePush for the location of your JS bundle, since it will "take control" of managing the current and all future versions. To do this, perform the following steps:
45+
Once your Xcode project has been setup to build/link the CodePush plugin, you need to configure your app to consult CodePush for the location of your JS bundle, since it is responsible for synchronizing it with updates that are released to the CodePush server. To do this, perform the following steps:
4646

4747
1. Open up the `AppDelegate.m` file, and add an import statement for the CodePush headers:
4848

@@ -92,14 +92,14 @@ The simplest way to do this is to perform the following in your app's root compo
9292
CodePush.sync();
9393
```
9494
95-
If an update is available, it will be silently downloaded, and installed the next time the app is restarted (either explicitly by the end-user or by the OS). This experience ensures the least invasive experience for your end-users. If you would like to display a confirmation dialog (an "active install"), or customize the update experience in any way, refer to the `sync` method's [API reference](#codepushsync) for information on how to tweak this default behavior.
95+
If an update is available, it will be silently downloaded, and installed the next time the app is restarted (either explicitly by the end-user or by the OS), which ensures the least invasive experience for your end-users. If you would like to display a confirmation dialog (an "active install"), or customize the update experience in any way, refer to the `sync` method's [API reference](#codepushsync) for information on how to tweak this default behavior.
9696
9797
## Releasing code updates
9898
9999
Once your app has been configured and distributed to your users, and you've made some JS changes, it's time to release it to them instantly! To do this, run the following steps:
100100
101101
1. Execute `react-native bundle` in order to generate the JS bundle for your app.
102-
2. Execute `code-push release <appName> ./ios/main.jsbundle <appVersion>` in order to publish the generated JS bundle to the server (assuming your CWD is the root directory of your React Native app).
102+
2. Execute `code-push release <appName> ./ios/main.jsbundle <appVersion> --deploymentName <deploymentName>` in order to publish the generated JS bundle to the server (assuming your CWD is the root directory of your React Native app).
103103
104104
And that's it! For more information regarding the CodePush API, including the various options you can pass to the `sync` method, refer to the reference section below.
105105

0 commit comments

Comments
 (0)