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

Commit b3af19c

Browse files
author
Will Anderson
committed
Add top-level API docs and getting started section
1 parent 3157b76 commit b3af19c

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Installation
1010
npm install --save react-native-code-push
1111
```
1212

13-
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.
13+
After installing the React Native Code Push plugin, open your project in Xcode. Open the `react-native-code-push` in Finder, and drag the `CodePush.xcodeproj` into the Libraries folder of Xcode.
1414

1515
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.
1616

@@ -28,6 +28,26 @@ jsCodeLocation = [CodePush getBundleUrl];
2828

2929
This change allows Code Push to load the updated app location after an update has been applied.
3030

31+
Methods
32+
---
33+
34+
* checkForUpdate: Checks the service for updates
35+
* notifyApplicationReady: Notifies the plugin that the update operation succeeded.
36+
* getCurrentPackage: Gets information about the currently applied package.
37+
38+
Objects
39+
---
40+
41+
* LocalPackage: Contains information about a locally installed package.
42+
* RemotePackage: Contains information about an updated package available for download.
43+
44+
Getting Started:
45+
---
46+
47+
* Add the plugin to your app
48+
* Open your app's `Info.plist` and add a "CodePushDeploymentKey" entry with your app's deployment key
49+
* To publish an update for your app, run `react-native bundle`, and then publish `iOS/main.jsbundle` using the Code Push CLI.
50+
3151
Running the Example
3252
---
3353

0 commit comments

Comments
 (0)