From 4b3bb39fc7543fbb7fd86433f2f97eb0f9501504 Mon Sep 17 00:00:00 2001 From: Geoffrey Goh Date: Fri, 16 Oct 2015 14:33:59 -0700 Subject: [PATCH] Update README.md Add How It Works section to sync with Cordova project --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 78aa74b..50a3476 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,22 @@ react-native-code-push === -React Native module for deploying script updates using the CodePush service. +This plugin provides integration with the CodePush service, allowing you to easily update your React Native application to enable live app updates. + +Supported platforms +--- + +- iOS +- Coming soon: Android + +How does it work? +--- + +A React Native application's assets (JavaScript code and other resources) are traditionally bundled up as a ```.jsbundle``` file which is loaded from the application installation location on the target device during runtime. After you submit an update to the store, the user downloads the update, and those assets will be replaced with the new assets. + +CodePush is here to simplify this process by allowing you to instantly update your application's assets without having to submit a new update to the store. We do this by allowing you to upload and manage your React Native app bundles on our CodePush server. In the application, we check for the presence of updated bundles on the server and install and persist them to the internal storage of the device if they are available. If a new bundle is installed, the application will reload from the updated package location. + +For an easy way to get started, please see our [demo application](/Examples/CodePushDemoApp) and our [getting started guide](#getting-started). Installation ---