kylefang/react-native-code-push
1
0
Fork 0
mirror of https://github.com/zhigang1992/react-native-code-push.git synced 2026-05-26 23:30:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add installation instructions to readme

Browse Source
This commit is contained in:
Will Anderson
2015-10-05 10:03:11 -07:00
parent 6b7b31100f
commit 3157b764f1
1 changed files with 30 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@@ -1,17 +1,41 @@
code-push-react-native
react-native-code-push
===
React Native module for deploying script updates
React Native module for deploying script updates using the Code Push service.
Installation
---
```
npm install --save react-native-code-push
```
After installing the React Native Code Push plugin, open your project in Xcode. Open `node_modules/react-native-code-push` in Finder, and drag the `CodePush.xcodeproj` into the Libraries folder of Xcode.
In Xcode, click on your project, and select the "Build Phases" tab of your project configuration. Drag libCodePush.a from `Libraries/CodePush.xcodeproj/Products` into the "Link Binary With Libraries" secton of your project's "Build Phases" configuration.
Finally, edit your project's `AppDelegate.m`. Find the following code:
```
jsCodeLocation = [NSURL URLWithString:@"http://localhost:8081/index.ios.bundle?platform=ios&dev=true"];
```
Replace it with the following:
```
jsCodeLocation = [CodePush getBundleUrl];
```
This change allows Code Push to load the updated app location after an update has been applied.
Running the Example
---
* Make sure you have https://github.com/Microsoft/hybrid-mobile-deploy cloned beside the react-native project in a folder called `website`. This is hacky, and will be cleaned up as soon as React Native's packager supports symlinks.
* Start the CodePush server with `gulp serve`, after installing the prerequisites described in the [project readme](https://github.com/Microsoft/hybrid-mobile-deploy/blob/master/README.md)
* Clone this repository
* From the root of this project, run `npm install`
* `cd` into `Examples/CodePushDemoApp`
* From this demo app folder, run `npm install`
* Open `Info.plist` and fill in the values for CodePushDeploymentKey and CodePushServerUrl
* Open `Info.plist` and fill in the value for CodePushDeploymentKey
* Run `npm start` to launch the packager
* Open `CodePushDemoApp.xcodeproj` in Xcode
* Launch the project
@@ -22,4 +46,4 @@ Running Tests
* Open `CodePushDemoApp.xcodeproj` in Xcode
* Navigate to the test explorer (small grey diamond near top left)
* Click on the 'play' button next to CodePushDemoAppTests
* After the tests are completed, green ticks should appear next to the test cases to indicate success
* After the tests are completed, green ticks should appear next to the test cases to indicate success