@revopush/code-push-cli 0.0.2 → 0.0.3

package/README.md

@@ -1,36 +1,60 @@
-## 1. Introduction
-
-Over-the-air (OTA) updates are a vital aspect of modern mobile application development, 
-enabling developers to push updates directly to users' devices without requiring them to download a new app version from the store.
+**Guide Overview:**
+1. [Introduction](#1-introduction)
+2. [Prerequisites](#2-prerequisites)
+    - 2.1 [Installing Required Tools](#21-installing-required-tools)
+    - 2.2 [Setting Up Revopush CLI](#22-setting-up-revopush-cli)
+3. [Migrating from Appcenter to Revopush](#3-migrating-from-appcenter-to-revopush)
+    - 3.1 [Logging In](#31-logging-in)
+    - 3.2 [Migrating Applications and Deployments](#32-migrating-applications-and-deployments)
+4. [Setting Up Revopush from Scratch](#4-setting-up-revopush-from-scratch)
+    - 4.1 [Logging In](#41-logging-in)
+    - 4.2 [Creating Applications](#42-creating-applications)
+    - 4.3 [Creating Deployments](#43-creating-deployments)
+5. [Updating Your React Native App](#5-updating-your-react-native-app)
+    - 5.1 [iOS Configuration](#51-ios-configuration)
+    - 5.2 [Android Configuration](#52-android-configuration)
+6. [Releasing Updates](#6-releasing-updates)
+    - 6.1 [For iOS](#61-for-ios)
+    - 6.2 [For Android](#62-for-android)
+    - 6.3 [Additional Options](#63-additional-options)
+7. [Summary and Resources](#7-summary-and-resources)
 
-This step-by-step guide will walk you through the process of migrating your OTA updates from Appcenter to Revopush 
-whether you’re an experienced developer familiar with Appcenter or a beginner exploring Revopush applying OTA for your app from scratch.
+## 1. Introduction
 
-Guide contains the following steps:
+Welcome! This guide will help you migrate your Over-the-Air (OTA) updates from Appcenter to Revopush. 
+With Revopush's Command Line Interface (CLI), you can easily push updates directly to your users' devices 
+without needing to go through app stores.
 
-- Pre-requisites. Just a few things you need to have installed or updated before you start. 
-If you did not use Appcenter OTA updates before and just wish to apply OTA on top of Revopush for your app go right to the step 2.2
-- Appcenter to Revopush migration. This section will guide you through the process of migrating your applications, deployments from Appcenter to Revopush.
-If you did not use Appcenter OTA updates before and just wish to apply OTA on top of Revopush for your app feel free to skip this section and go to section 4.
-- Create Application and Deployments in Revopush. This section will guide you through the process of creation of application, deployments in Revopush.
-- Migrate your React Native application to Revopush OTA. There we describe required changes in your React Native application to start using Revopush OTA.
-- Summary. This section will summarize the key points of the guide and provide you with additional resources to help you get the most out of Revopush.
+**What You'll Learn:**
+- How to install the Revopush CLI
+- Migrating your existing OTA updates from Appcenter
+- Setting up and managing your applications and deployments in Revopush
+- Updating your React Native app to use Revopush for OTA updates
 
 Let’s get started!
 
 ## 2. Prerequisites
 
-Whether you start from scratch or migrate from Appcenter to Revopush, 
-you need necessary developer tools installed on your machine (eg [Node.js](https://nodejs.org/en), npm, yarn, npx, Android Studio, Xcode, VS Code, etc.)
-which you used to use for your React Native application development. You should have permissions to install npm packages globally for further CodePush updates.
+Before you begin, ensure you have the following (depends on your platform and preferences):
+
+- **Developer Tools Installed:**
+    - [Node.js](https://nodejs.org/)
+    - npm or Yarn
+    - npx
+    - [Android Studio](https://developer.android.com/studio)
+    - [Xcode](https://developer.apple.com/xcode/)
+    - [Visual Studio Code](https://code.visualstudio.com/)
 
-Create an account on [Revopush](https://app.revopush.org/register) to manage your applications and deployments via both UI and CLI 
-using GitHub or Google as an authentication provider.
+- **Permissions:**
+    - Ability to install npm packages globally.
 
-If you migrate existing application from Appcenter to Revopush you should have access to [Appcenter](https://appcenter.ms/) 
-to use their UI and CLI.
+- **Revopush Account:**
+    - Sign up at [Revopush](https://revopush.org/) using GitHub or Google for authentication.
 
-### 2.1 Appcenter Command Line Interface
+- **(If Migrating) Appcenter Access:**
+    - Ensure you have access to your existing Appcenter account and its CLI.
+
+### 2.1 Installing Required Tools
 You manage most of CodePush's functionality using the App Center CLI.
 If you had one installed, you can update it to the latest version by running the following command:
 
@@ -78,23 +102,24 @@ Commands:
     setup-autocomplete             Setup tab completion for your shell 
 ```
 
-### 2.2 Revopush Command Line Interface
+### 2.2 Setting Up Revopush CLI
 Similarly to Appcenter Revopush manages the most of CodePush's functionality using CLI.
 
 To install it run the following command:
 
+**Install Revopush CLI:**
 ```shell
    npm install -g @revopush/code-push-cli
 ```
 
-We also suggest you to periodically update the CLI to the latest version by running the following command:
-
+**Update Revopush CLI to the Latest Version:**
 ```shell
    npm update -g @revopush/code-push-cli
 ```
 
 Upon installation or update, you can check the version of the Revopush CLI and the list of available commands by running the following command:
 
+**Verify Installation:**
 ```shell
    revopush -h
 ```
@@ -136,14 +161,14 @@ Options:
 
 ```
 
- ## 3. Appcenter to Revopush migration
+ ## 3. Migrating from Appcenter to Revopush
 
 You need to execute steps in this section if you have been using Appcenter for OTA updates and wish to migrate to Revopush.
 
 If you did not use Appcenter OTA updates before and just wish to apply
-OTA on top of Revopush for your app feel free to skip this section and go to section 4.
+OTA on top of Revopush for your app feel free to skip this section and go to section [4](#4-setting-up-revopush-from-scratch).
 
-### 3.1 Login to Appcenter and Revopush CLI
+### 3.1 Logging In
 
 Execute the following command to login to Appcenter CLI using provider of your choice (GitHub, Facebook, Microsoft, Google):
 
@@ -157,14 +182,14 @@ Similarly, in a separate window login to Revopush CLI using the following comman
   revopush login
 ```
 
-### 3.2 Define the list of application to migrate
-After login you can check the list of apps you have access to by running the following command:
+### 3.2 Migrating Applications and Deployments
+**1. List Your Appcenter Apps:**
 
 ```shell
   appcenter apps list
 ```
 
-Which will display something like this:
+Example Output:
 
 ```shell
   johndoe/rn2_android
@@ -176,7 +201,7 @@ is the React Native application for iOS.
 
 You can check target OS of the app using command `appcenter apps show -a <app name here>`.
 
-Android:
+**Android:**
 
 ```shell
 appcenter apps show -a johndoe/rn2_android
@@ -194,7 +219,7 @@ Owner Name:            johndoe
 Azure Subscription ID: 
 ```
 
-iOS:
+**iOS:**
 
 ```shell
 appcenter apps show -a johndoe/rn2_ios    
@@ -212,21 +237,18 @@ Owner Name:            johndoe
 Azure Subscription ID: 
 ```
 
-### 3.2 Create applications in Revopush
 
-Now you have to create applications in Revopush for each of the applications you have in Appcenter.
-Please keep in mind, compare to Appcenter, Revopush does not accept username (`<username>/<app name>`) as an application name,
-you just need to take part after `<username>` in the Appcenter app name. For example:
+**2. Create Corresponding Revopush Apps:**
 
-`johndoe/rn2_ios` becomes `rn2_ios`, 
-`johndoe/rn2_android` becomes `rn2_android`.
+Remove the username prefix when creating apps in Revopush.
 
-Having these names execute the following command to create applications:
 ```shell
   revopush app add rn2_ios
+  revopush app add rn2_android
 ```
 
-with response like
+Example Output:
+
 ```shell
 Successfully added the "rn2_ios" app, along with the following default deployments:
 ┌────────────┬────────────────────────────────────────┐
@@ -238,12 +260,6 @@ Successfully added the "rn2_ios" app, along with the following default deploymen
 └────────────┴────────────────────────────────────────┘
 ```
 
-and another one for Android:
-```shell
-  revopush app add rn2_android
-```
-
-with response like
 ```shell
 Successfully added the "rn2_android" app, along with the following default deployments:
 ┌────────────┬────────────────────────────────────────┐
@@ -255,232 +271,88 @@ Successfully added the "rn2_android" app, along with the following default deplo
 └────────────┴────────────────────────────────────────┘
 ```
 
-Out of the box, Revopush will also create two deployments (Staging and Production) for the application you have created.
-It empowers you to use the best practices of [Multi-Deployment Testing](https://learn.microsoft.com/en-us/appcenter/distribution/codepush/rn-deployment). 
-You can add more deployments later or delete if you need to. However, you do not have to remember or save these deployments keys, 
-because you can always take them using Revopush CLI.
-
-### 3.2 Replicate Appcenter Deployments in Revopush
-
-Revopush allows you to create multiple deployments for each application with the same deployment keys as you have in Appcenter.
-The reason for that is that these keys are treated as a sort of secrets (for instance these can be used in your CI/CD pipeline, 
-environment variables on developer machine or build server, mobile app, etc). 
-To reduce frictions in migration process and make the process as smooth as possible 
-we recommend you to reuse these keys in Revopush deployments.
-
-In examples below we assume you have 2 deployments in Appcenter for every app: `Staging` and `Production`. 
-Actual number of deployments can be different in your case but idea is the same - re-create these with identical keys in Revopush.
 
-Run the following command:
+**3. Replicate Deployments:**
 
-#### iOS
+List Appcenter deployments:
 
 ```shell
-  appcenter codepush deployment list -k -a johndoe/rn2_ios
+appcenter codepush deployment list -k -a johndoe/rn2_ios
 ```
 
-which will display something like this:
-```shell
-┌────────────┬────────────────────────────────────────┐
-│ Name       │ Key                                    │
-├────────────┼────────────────────────────────────────┤
-│ Production │ xJeOl4A5No7c9-wJv8HLj1ktmmKeP5awD0us5u │
-├────────────┼────────────────────────────────────────┤
-│ Staging    │ ZFZiSAKLUL_QmBXeWAcSkpv87fkaDeWu1W0TOs │
-└────────────┴────────────────────────────────────────┘
-```
-
-Add Revopush deployment for iOS with the same keys running command to replicate Staging
-```shell
-revopush deployment add rn2_ios appcenter_Staging -k ZFZiSAKLUL_QmBXeWAcSkpv87fkaDeWu1W0TOs
-```
+Add the same deployments in Revopush with identical keys
 
-and the following command to replicate Production
 ```shell
-revopush deployment add rn2_ios appcenter_Production -k xJeOl4A5No7c9-wJv8HLj1ktmmKeP5awD0us5u
+revopush deployment add rn2_ios appcenter_Staging -k <Staging_Key>
+revopush deployment add rn2_ios appcenter_Production -k <Production_Key>
 ```
 
-where: 
-- `rn2_ios` is the application name in Revopush
-- `appcenter_Staging` and `appcenter_Production` are the deployment names in Revopush (the same as in Appcenter but for sake of clarity we added `appcenter_` prefix)
-- `ZFZiSAKLUL_QmBXeWAcSkpv87fkaDeWu1W0TOs` is the deployment key for `Staging` in Appcenter
-- `xJeOl4A5No7c9-wJv8HLj1ktmmKeP5awD0us5u` is the deployment key for `Production` in Appcenter
-
-Help tip:
-Until you switched your mobile application to use Revopush (more about this below) or during testing it's totally fine to delete the deployment in Revopush.
-
-To delete deployment if you need run the following command:
-
-```shell
-revopush deployment rm rn2_ios appcenter_Staging
-````
-
-#### Android
-
-For Android app steps are very similar except different app name. List deployments in Appcenter:
+Repeat for Android
 
 ```shell
 appcenter codepush deployment list -k -a johndoe/rn2_android
+revopush deployment add rn2_android appcenter_Staging -k <Staging_Key>
+revopush deployment add rn2_android appcenter_Production -k <Production_Key>
 ```
 
-with output like this:
-```shell
-┌────────────┬────────────────────────────────────────┐
-│ Name       │ Key                                    │
-├────────────┼────────────────────────────────────────┤
-│ Production │ PQPwJaW63MTPI8T__u168qJm7Vq7Mn0UJ94MMR │
-├────────────┼────────────────────────────────────────┤
-│ Staging    │ 4tK3WlLhumcwaukx68Irq04XqS_3R4H6N-lV-z │
-└────────────┴────────────────────────────────────────┘
-```
-
-Add Revopush Android Staging deployment
-```shell
-revopush deployment add rn2_android appcenter_Staging -k 4tK3WlLhumcwaukx68Irq04XqS_3R4H6N-lV-z
-```
-
-Add Revopush Android Production deployment
-
-```shell
-revopush deployment add rn2_android appcenter_Production -k PQPwJaW63MTPI8T__u168qJm7Vq7Mn0UJ94MMR
-```
-
-where:
-- `rn2_android` is the application name in Revopush
-- `appcenter_Staging` and `appcenter_Production` are the deployment names in Revopush (the same as in Appcenter but for sake of clarity we added `appcenter_` prefix)
-- `4tK3WlLhumcwaukx68Irq04XqS_3R4H6N-lV-z` is the deployment key for `Staging` in Appcenter
-- `PQPwJaW63MTPI8T__u168qJm7Vq7Mn0UJ94MMR` is the deployment key for `Production` in Appcenter
-
 Repeat for all other deployment you have in Appcenter and wish to continue to use in Revopush.
 
-## 4. Create Application and Deployments in Revopush
-
-You need to execute steps in this section if you start from scratch and wish to apply OTA on top of Revopush for your app.
-People who migrate from Appcenter to Revopush can skip this section (we have done all what we need in previous sections) 
-and go to section 5.
-
-It empowers you to use the best practices of [Multi-Deployment Testing](https://learn.microsoft.com/en-us/appcenter/distribution/codepush/rn-deployment)
-and have isolated app for iOS and Android each with few Deployments (at least `Staging` and `Production`).
-
+## 4. Setting Up Revopush from Scratch
 
-### 4.1 Login to Revopush CLI
+If you're new to Revopush and want to set up OTA updates for your app, follow these steps.
 
-Execute the following command to login to Revopush CLI using provider of your choice (GitHub, Google):
+### 4.1 Logging In
 
 ```shell
   revopush login
 ```
 
-### 4.2 Create applications in Revopush
+### 4.2 Creating Applications
 
-Revopush does not specify the target platform of the application at the moment of creation. 
-To later easy manage them we suggest to give them meaningful names which will contain platform as a part of it. 
-
-#### iOS
+#### For iOS
 
 ```shell
 revopush app add myAmazingApp_ios
 ```
 
-with response like
-
-```shell
-Successfully added the "myAmazingApp_ios" app, along with the following default deployments:
-┌────────────┬────────────────────────────────────────┐
-│ Name       │ Deployment Key                         │
-├────────────┼────────────────────────────────────────┤
-│ Production │ PRer2J8xeLerKNZ16Klsf5yfdc8uVJHvdy5W-g │
-├────────────┼────────────────────────────────────────┤
-│ Staging    │ vUOFPtZfOlhXHPEDE3nkf7nP6lJ4VJHvdy5W-g │
-└────────────┴────────────────────────────────────────┘
-````
-
-#### Android
+#### For Android:
 
 ```shell
 revopush app add myAmazingApp_android
 ```
 
-with response like
-```shell
-Successfully added the "myAmazingApp_android" app, along with the following default deployments:
-┌────────────┬────────────────────────────────────────┐
-│ Name       │ Deployment Key                         │
-├────────────┼────────────────────────────────────────┤
-│ Production │ I0N9-8MCI-JAAmlrbjGRROGFFFvtVJHvdy5W-g │
-├────────────┼────────────────────────────────────────┤
-│ Staging    │ kbAXqSrgEfLPcuvU3Fe0SCqX5HpOVJHvdy5W-g │
-└────────────┴────────────────────────────────────────┘
-````
-
-### 4.3 Create deployments in Revopush
+This will create your app along with default Staging and Production deployments.
 
-In addition to two deployments we create out of the box you may need to have more for your application (eg for development, testing).
+### 4.3 Creating Deployments
 
-The following command will create a new deployment for the application you have created:
+If you need more deployments (e.g., Development, Testing), use:
 
 ```shell
 revopush deployment add myAmazingApp_android Development
 ```
 
-with response like
-```shell
-Successfully added the "Development" deployment with key "7Eh9BWf9FIr4_d33ay_oj4zeVoYqVJHvdy5W-g" to the "myAmazingApp_android" app.
-```
-
-To list all the deployments with their keys for the application run the following command:
+List All Deployments:
 
 ```shell
 revopush deployment ls myAmazingApp_android -k
 ```
 
-which will display something like this:
-
-```shell
-┌─────────────┬────────────────────────────────────────┬─────────────────────┬──────────────────────┐
-│ Name        │ Deployment Key                         │ Update Metadata     │ Install Metrics      │
-├─────────────┼────────────────────────────────────────┼─────────────────────┼──────────────────────┤
-│ Development │ 7Eh9BWf9FIr4_d33ay_oj4zeVoYqVJHvdy5W-g │ No updates released │ No installs recorded │
-├─────────────┼────────────────────────────────────────┼─────────────────────┼──────────────────────┤
-│ Production  │ D32ZXaQ-JybAzpLIiwZaNqh2XgLRVJHvdy5W-g │ No updates released │ No installs recorded │
-├─────────────┼────────────────────────────────────────┼─────────────────────┼──────────────────────┤
-│ Staging     │ siXHHg5Pq1eFzFBdHKSMl23dqdxpVJHvdy5W-g │ No updates released │ No installs recorded │
-└─────────────┴────────────────────────────────────────┴─────────────────────┴──────────────────────┘
-```
-
-## 5. Migrate your React Native application to Revopush OTA
-
-The way how check for updates happens (eg on every app start, or fine-grained control involving user) 
-as well as when bundle is installed (eg immediately, on next restart or on next resume) heavy depends on 
-your application requirements and used version of React Native and CodePush plugin.
-
-Please refer to official documentation of [react-native-code-push](https://github.com/microsoft/react-native-code-push/tree/master?tab=readme-ov-file#plugin-usage) 
-plugin to find an approach which will fit your needs. 
+## 5. Updating Your React Native App
 
-At this point we assume you have already applied CodePush plugin on React side and completed setup of native modules 
-( [iOS](https://github.com/microsoft/react-native-code-push/blob/master/docs/setup-ios.md),
-[Android](https://github.com/microsoft/react-native-code-push/blob/master/docs/setup-android.md))
+After setting up Revopush, update your React Native application to point to the Revopush server.
 
-Below are steps to be done for iOS and Android to switch CodePush server location from Appcenter to Revopush.
+### 5.1 iOS Configuration
 
-### 5.1 Update CodePush server URL for iOS
-
-Open your app's `Info.plist` file and add a new entry named `CodePushServerURL` whose value is the URL of the Revopush API server.
+1. **Open `Info.plist`:** Add the following entries:
 
 ```xml
+<key>CodePushDeploymentKey</key>
+<string>Your_Deployment_Key</string>
 <key>CodePushServerURL</key>
 <string>https://api.revopush.org</string>
 ```
 
-Also be sure you do have an entry named `CodePushDeploymentKey` whose value is the key of the deployment you want to configure this app against
-(see section above how to get Deployment Key ). 
-
-```xml
-<key>CodePushDeploymentKey</key>
-<string>vUOFPtZfOlhXHPEDE3nkf7nP6lJ4VJHvdy5W-g</string>
-```
-
-As result for our `myAmazingApp_ios` app and `Staging` deployment `Info.plist` section related to CodePush will look like this:
+An example for `myAmazingApp_ios` app and `Staging` deployment:
 
 ```xml
 <key>CodePushDeploymentKey</key>
@@ -489,179 +361,101 @@ As result for our `myAmazingApp_ios` app and `Staging` deployment `Info.plist` s
 <string>https://api.revopush.org</string>
 ```
 
-_Note: If you need to dynamically use a different deployment, you can also override your deployment key in JS code using
-[Code-Push options](https://github.com/microsoft/react-native-code-push/blob/master/docs/api-js.md#CodePushOptions)_
+2. **Dynamic Deployment Key (Optional):** To switch deployments dynamically in your JavaScript code, use [Code-Push options](https://github.com/microsoft/react-native-code-push/blob/master/docs/api-js.md#CodePushOptions)
 
-### 5.2 Update CodePush server URL for Android
+### 5.2 Android Configuration
 
-Open your app's `strings.xml` file and add a new entry named `CodePushServerUrl` whose value is the URL of the Revopush API server.
+1. Open `strings.xml`: Add the following entries:
 
 ```xml
+<string moduleConfig="true" name="CodePushDeploymentKey">Your_Deployment_Key</string>
 <string moduleConfig="true" name="CodePushServerUrl">https://api.revopush.org</string>
 ```
 
-Also be sure you do have an entry named `CodePushDeploymentKey` whose value is the key of the deployment you want to configure this app against
-(see section above how to get Deployment Key ).
-
-```xml
-<string moduleConfig="true" name="CodePushDeploymentKey">kbAXqSrgEfLPcuvU3Fe0SCqX5HpOVJHvdy5W-g</string>
-```
-
-As result for our `myAmazingApp_android` app and `Staging` deployment `strings.xml` section related to CodePush will look like this:
+An example `myAmazingApp_android` app and `Staging` deployment `strings.xml`:
 
 ```xml
 <string moduleConfig="true" name="CodePushDeploymentKey">kbAXqSrgEfLPcuvU3Fe0SCqX5HpOVJHvdy5W-g</string>
 <string moduleConfig="true" name="CodePushServerUrl">https://api.revopush.org</string>
 ```
 
-_Note: If you need to dynamically use a different deployment, you can also override your deployment key in JS code using
-[Code-Push options](https://github.com/microsoft/react-native-code-push/blob/master/docs/api-js.md#CodePushOptions)_
-
+2.  **Dynamic Deployment Key (Optional):** To switch deployments dynamically in your JavaScript code, use [Code-Push options](https://github.com/microsoft/react-native-code-push/blob/master/docs/api-js.md#CodePushOptions)
 
-## 6. Release updates
+## 6. Releasing Updates
 
-Once your app is configured and distributed to your users, and you have made some JS or asset changes, it's time to release them.
+Once your app is configured, you can release updates to your users.
 
-Note: For Appcenter users most of the commands in Revopush CLI will look familiar or even identical. For your convenience we will show you 
-how to release updates for both platforms so you would adjust your scripts, CI/CD pipelines, etc if any.
-
-### 6.1 Release updates for iOS
-
-To push a bundle for iOS to the `Staging` deployment of the `rn2_ios` app, run the following command:
+### 6.1 For iOS
 
 ```shell
 revopush release-react rn2_ios ios -d Staging
 ```
 
-Under the hood, this command will run `react-native bundle` command to create a bundle and assets,
-then upload them to Revopush server and release the update to the `Staging` deployment of the `rn2_ios` app.
+**What Happens:**
+- Bundles your JavaScript code.
+- Uploads the bundle and assets to Revopush.
+- Releases the update to the Staging deployment of rn2_ios.
 
-Upon successful release, you will see something like this:
+**Success Message:**
 
 ```shell
-Detecting ios app version:
-
-Using the target binary version value "0.0.1" from "ios/rn2/Info.plist".
-
-Running "react-native bundle" command:
-
-node node_modules/react-native/cli.js bundle --assets-dest /var/folders/my/lwrczz7503g5911_wf51jsvm0000gp/T/CodePush --bundle-output /var/folders/my/lwrczz7503g5911_wf51jsvm0000gp/T/CodePush/main.jsbundle --dev false --entry-file index.js --platform ios
-Welcome to Metro v0.81.0
-              Fast - Scalable - Integrated
-
-info Writing bundle output to: /var/folders/my/lwrczz7503g5911_wf51jsvm0000gp/T/CodePush/main.jsbundle
-info Done writing bundle output
-info Copying 1 asset files
-info Done copying assets
-private key was not provided
-
-Releasing update contents to CodePush:
-
-Upload progress:[==================================================] 100% 0.0s
+...
 Successfully released an update containing the "/var/folders/my/lwrczz7503g5911_wf51jsvm0000gp/T/CodePush" directory to the "Staging" deployment of the "rn2_ios" app.
 ```
 
-where:
-- `rn2_ios` is the application name in Revopush
-- `Staging` is the deployment name in Revopush
-- `ios` is the target platform
-
-The entire list of available options such as bundle name, entry file, whether this release should be considered mandatory,
-rercentage of users this release should be immediately available to and many others for the `release-react` command can be found in CLI
-
-```shell
-revopush release-react -h
-```
-
-### 6.2 Release updates for Android
-
-To push a bundle for Android to the `appcenter-Staging` deployment of the `rn2_android` app, run the following command:
+### 6.2 For Android
 
 ```shell
 revopush release-react rn2_android android -d appcenter-Staging
 ```
 
-Under the hood, this command will run `react-native bundle` command to create a bundle and assets, then upload them to Revopush server and release the update to the `Staging` deployment of the `rn2_android` app.
-
-Upon successful release, you will see something like this:
-
-```shell
-Detecting android app version:
-
-Using the target binary version value "1.0" from "android/app/build.gradle".
-
-Running "react-native bundle" command:
-
-node node_modules/react-native/cli.js bundle --assets-dest /var/folders/my/lwrczz7503g5911_wf51jsvm0000gp/T/CodePush --bundle-output /var/folders/my/lwrczz7503g5911_wf51jsvm0000gp/T/CodePush/index.android.bundle --dev false --entry-file index.js --platform android
-Welcome to Metro v0.81.0
-              Fast - Scalable - Integrated
+**What Happens:**
 
-info Writing bundle output to: /var/folders/my/lwrczz7503g5911_wf51jsvm0000gp/T/CodePush/index.android.bundle
-info Done writing bundle output
-info Copying 1 asset files
-info Done copying assets
-private key was not provided
+- Bundles your JavaScript code.
+- Uploads the bundle and assets to Revopush.
+- Releases the update to the appcenter-Staging deployment of rn2_android.
 
-Releasing update contents to CodePush:
+**Success Message:**
 
-Upload progress:[==================================================] 100% 0.0s
+```shell
+...
 Successfully released an update containing the "/var/folders/my/lwrczz7503g5911_wf51jsvm0000gp/T/CodePush" directory to the "appcenter-Staging" deployment of the "rn2_android" app.
 ```
 
-where:
-- `rn2_android` is the application name in Revopush
-- `appcenter-Staging` is the deployment name in Revopush
-- `android` is the target platform
+### 6.3 Additional Options
 
-The entire list of available options such as bundle name, entry file, whether this release should be considered mandatory,
-rercentage of users this release should be immediately available to and many others for the `release-react` command can be found in CLI 
+For more customization, view all options:
 
 ```shell
 revopush release-react -h
 ```
 
-### 6.3 Release history
+## 7. Summary and Resources
 
-The release history for deployment of the app can be viewed in Revopush UI or if you prefer CLI by running the following command:
 
-```shell
-revopush deployment history rn2_ios Staging
-```
+Migrating your OTA updates from Appcenter to Revopush is straightforward with our CLI tools. 
+Whether you're migrating existing applications or setting up new ones,
+Revopush offers a seamless experience with familiar commands and robust features.
 
-with response like
 
-```shell
-┌───────┬───────────────┬─────────────┬───────────┬─────────────┬──────────────────────┐
-│ Label │ Release Time  │ App Version │ Mandatory │ Description │ Install Metrics      │
-├───────┼───────────────┼─────────────┼───────────┼─────────────┼──────────────────────┤
-│ v1    │ 8 minutes ago │ 0.0.1       │ No        │             │ No installs recorded │
-└───────┴───────────────┴─────────────┴───────────┴─────────────┴──────────────────────┘
-```
-
-## 7. Summary
-
-At Revopush we tried to make the migration process as smooth as possible.
-For experienced developers who have been using Appcenter CLI for OTA updates, 
-commands in Revopush CLI will look familiar or even identical.
-
-For your convenience we created a table with the most common commands you may need to use in Revopush CLI 
-(with their analogs in Appcenter CLI):
-
-| Appcenter                        | Revopush               |                                                                     Comment                                                                      | 
-|:---------------------------------|:-----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------:|
-| appcenter login                  | revopush login         |                                                                      Log in                                                                      |
-| appcenter codepush deployment    | revopush deployment    |                                                       View and manage your app deployments                                                       |
-| appcenter apps                   | revopush app           |                                                            View and manage your apps                                                             |
-| appcenter codepush patch         | revopush patch         |                                               Update the metadata for an existing CodePush release                                               |
-| appcenter codepush promote       | revopush promote       | Create a new release for the destination deployment, which includes the exact code and metadata from the latest release of the source deployment |
-| appcenter codepush release-react | revopush release-react |                                                Release a React Native update to an app deployment                                                |
-| appcenter codepush rollback      | revopush rollback      |                                                   Rollback a deployment to a previous release                                                    |
-| appcenter logout                 | revopush logout        |                                                                     Log out                                                                      |
-
-### Resources which maybe helpful:
+**Quick Command Reference:**
+
+| Appcenter                        | Revopush                |                                                                     Comment                                                                      | 
+|:---------------------------------|:------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------:|
+| `appcenter login`                 | `revopush login`         |                                                                      Log in                                                                      |
+| `appcenter codepush deployment`   | `revopush deployment`    |                                                       View and manage your app deployments                                                       |
+| `appcenter apps`                  | `revopush app`           |                                                            View and manage your apps                                                             |
+| `appcenter codepush patch`        | `revopush patch`         |                                               Update the metadata for an existing CodePush release                                               |
+| `appcenter codepush promote`      | `revopush promote`       | Create a new release for the destination deployment, which includes the exact code and metadata from the latest release of the source deployment |
+| `appcenter codepush release-react`| `revopush release-react` |                                                Release a React Native update to an app deployment                                                |
+| `appcenter codepush rollback`    | `revopush rollback`       |                                                   Rollback a deployment to a previous release                                                    |
+| `appcenter logout`               | `revopush logout`         |                                                                     Log out                                                                      |
+
+### **Helpful Resources:**
 - React Native CodePush [GitHub](https://github.com/microsoft/react-native-code-push)
 - React Native Client SDK [docs](https://learn.microsoft.com/en-us/appcenter/distribution/codepush/rn-overview)
 - Best practices for [Multi-Deployment Testing](https://learn.microsoft.com/en-us/appcenter/distribution/codepush/rn-deployment)
 
-We hope this guide will help you to migrate your OTA updates from Appcenter to Revopush and start using the new features we provide.
-Your questions, feedback, and suggestions are always welcome. Please feel free to reach out to us at support@revopush.org
+**Need More Help?**
+Contact our support team at [support@revopush.org](mailto:support@revopush.org) or visit our [website](https://revopush.org).
+

package/guied.md

@@ -0,0 +1,351 @@
+Improving the readability and simplicity of your guide will make it more accessible to new users, ensuring they can easily follow the steps to install the CLI and understand its functionality from the outset. Here are several suggestions to enhance your article:
+
+### 1. **Clarify the Introduction**
+- **Simplify Language:** Use straightforward language to explain what the CLI does and how to install it right from the beginning.
+- **Highlight Key Points Early:** Mention the installation process and the primary functions of the CLI within the first few sentences.
+
+**Revised Introduction Example:**
+```markdown
+### 1. Introduction
+
+Welcome! This guide will help you migrate your Over-the-Air (OTA) updates from Appcenter to Revopush. With Revopush's Command Line Interface (CLI), you can easily push updates directly to your users' devices without needing to go through app stores.
+
+**What You'll Learn:**
+- How to install the Revopush CLI
+- Migrating your existing OTA updates from Appcenter
+- Setting up and managing your applications and deployments in Revopush
+- Updating your React Native app to use Revopush for OTA updates
+
+Let’s get started!
+```
+
+### 2. **Streamline the Table of Contents**
+- **Use Clear Headings:** Ensure each section title clearly reflects its content.
+- **Simplify Navigation:** Number sections sequentially and use consistent terminology.
+
+**Revised Table of Contents Example:**
+```markdown
+**Guide Overview:**
+1. Introduction
+2. Prerequisites
+   - 2.1 Installing Required Tools
+   - 2.2 Setting Up Revopush CLI
+3. Migrating from Appcenter to Revopush
+   - 3.1 Logging In
+   - 3.2 Migrating Applications and Deployments
+4. Setting Up Revopush from Scratch
+   - 4.1 Logging In
+   - 4.2 Creating Applications
+   - 4.3 Creating Deployments
+5. Updating Your React Native App
+   - 5.1 iOS Configuration
+   - 5.2 Android Configuration
+6. Releasing Updates
+   - 6.1 For iOS
+   - 6.2 For Android
+7. Summary and Resources
+```
+
+### 3. **Enhance Prerequisites Section**
+- **Break Down Information:** Separate tool installations and account setups for clarity.
+- **Use Bullet Points:** Make requirements easy to scan.
+
+**Revised Prerequisites Example:**
+```markdown
+### 2. Prerequisites
+
+Before you begin, ensure you have the following:
+
+- **Developer Tools Installed:**
+  - [Node.js](https://nodejs.org/)
+  - npm or Yarn
+  - npx
+  - [Android Studio](https://developer.android.com/studio)
+  - [Xcode](https://developer.apple.com/xcode/)
+  - [Visual Studio Code](https://code.visualstudio.com/)
+
+- **Permissions:**
+  - Ability to install npm packages globally.
+
+- **Revopush Account:**
+  - Sign up at [Revopush](https://revopush.org/) using GitHub or Google for authentication.
+
+- **(If Migrating) Appcenter Access:**
+  - Ensure you have access to your existing Appcenter account and its CLI.
+```
+
+### 4. **Improve CLI Installation Instructions**
+- **Highlight Commands:** Use code blocks for commands to differentiate them from the text.
+- **Add Explanations:** Briefly explain what each command does.
+
+**Revised CLI Installation Example:**
+```markdown
+#### 2.2 Setting Up Revopush CLI
+
+**Install Revopush CLI:**
+```bash
+npm install -g @revopush/code-push-cli
+```
+
+**Update Revopush CLI to the Latest Version:**
+```bash
+npm update -g @revopush/code-push-cli
+```
+
+**Verify Installation:**
+```bash
+revopush -h
+```
+This command displays the Revopush CLI version and available commands.
+```
+
+### 5. **Use Visual Aids and Formatting**
+- **Add Screenshots:** Visual representations of CLI outputs or UI steps can help users follow along.
+- **Consistent Formatting:** Use headings, subheadings, bullet points, and numbered lists consistently to organize information.
+
+### 6. **Simplify Migration Steps**
+- **Combine Similar Steps:** Merge sections that have overlapping instructions to reduce redundancy.
+- **Provide Clear Examples:** Use consistent naming conventions in examples to avoid confusion.
+
+**Revised Migration Steps Example:**
+```markdown
+### 3. Migrating from Appcenter to Revopush
+
+Follow these steps if you're moving your OTA updates from Appcenter to Revopush.
+
+#### 3.1 Logging In
+
+**Log in to Appcenter CLI:**
+```bash
+appcenter login
+```
+
+**Log in to Revopush CLI:**
+```bash
+revopush login
+```
+
+#### 3.2 Migrating Applications and Deployments
+
+1. **List Your Appcenter Apps:**
+   ```bash
+   appcenter apps list
+   ```
+   Example Output:
+   ```
+   johndoe/rn2_android
+   johndoe/rn2_ios
+   ```
+
+2. **Create Corresponding Revopush Apps:**
+   - Remove the username prefix when creating apps in Revopush.
+   ```bash
+   revopush app add rn2_ios
+   revopush app add rn2_android
+   ```
+
+3. **Replicate Deployments:**
+   - List Appcenter deployments:
+     ```bash
+     appcenter codepush deployment list -k -a johndoe/rn2_ios
+     ```
+   - Add the same deployments in Revopush with identical keys:
+     ```bash
+     revopush deployment add rn2_ios appcenter_Staging -k <Staging_Key>
+     revopush deployment add rn2_ios appcenter_Production -k <Production_Key>
+     ```
+   - Repeat for Android:
+     ```bash
+     appcenter codepush deployment list -k -a johndoe/rn2_android
+     revopush deployment add rn2_android appcenter_Staging -k <Staging_Key>
+     revopush deployment add rn2_android appcenter_Production -k <Production_Key>
+     ```
+```
+
+### 7. **Provide Clear Instructions for New Setups**
+- **Separate New Users and Migrators:** Clearly differentiate steps for users starting fresh versus those migrating.
+- **Use Step-by-Step Guides:** Break down each action into simple, numbered steps.
+
+**Revised New Setup Example:**
+```markdown
+### 4. Setting Up Revopush from Scratch
+
+If you're new to Revopush and want to set up OTA updates for your app, follow these steps.
+
+#### 4.1 Logging In
+
+```bash
+revopush login
+```
+
+#### 4.2 Creating Your Application
+
+**For iOS:**
+```bash
+revopush app add myAmazingApp_ios
+```
+
+**For Android:**
+```bash
+revopush app add myAmazingApp_android
+```
+
+This will create your app along with default **Staging** and **Production** deployments.
+
+#### 4.3 Creating Additional Deployments
+
+If you need more deployments (e.g., Development, Testing), use:
+
+```bash
+revopush deployment add myAmazingApp_android Development
+```
+
+**List All Deployments:**
+```bash
+revopush deployment ls myAmazingApp_android -k
+```
+```
+
+### 8. **Simplify Configuration Steps**
+- **Use Clear Code Blocks:** Ensure code snippets are correctly formatted and easy to copy.
+- **Explain Each Configuration Change:** Briefly describe why each change is necessary.
+
+**Revised Configuration Example:**
+```markdown
+### 5. Updating Your React Native App to Use Revopush OTA
+
+After setting up Revopush, update your React Native application to point to the Revopush server.
+
+#### 5.1 iOS Configuration
+
+1. **Open `Info.plist`:** Add the following entries:
+   ```xml
+   <key>CodePushDeploymentKey</key>
+   <string>Your_Deployment_Key</string>
+   <key>CodePushServerURL</key>
+   <string>https://api.revopush.org</string>
+   ```
+
+2. **Dynamic Deployment Key (Optional):** To switch deployments dynamically in your JavaScript code, use Code-Push options.
+
+#### 5.2 Android Configuration
+
+1. **Open `strings.xml`:** Add the following entries:
+   ```xml
+   <string moduleConfig="true" name="CodePushDeploymentKey">Your_Deployment_Key</string>
+   <string moduleConfig="true" name="CodePushServerUrl">https://api.revopush.org</string>
+   ```
+
+2. **Dynamic Deployment Key (Optional):** Override the deployment key in your JavaScript code using Code-Push options.
+```
+
+### 9. **Enhance the Release Process Section**
+- **Consistent Instructions:** Ensure steps for iOS and Android are parallel for easier comparison.
+- **Highlight Important Notes:** Use callouts or italics to emphasize crucial information.
+
+**Revised Release Process Example:**
+```markdown
+### 6. Releasing Updates
+
+Once your app is configured, you can release updates to your users.
+
+#### 6.1 Releasing for iOS
+
+```bash
+revopush release-react rn2_ios ios -d Staging
+```
+
+**What Happens:**
+- Bundles your JavaScript code.
+- Uploads the bundle and assets to Revopush.
+- Releases the update to the **Staging** deployment of **rn2_ios**.
+
+**Success Message:**
+```
+Successfully released an update to the "Staging" deployment of the "rn2_ios" app.
+```
+
+#### 6.2 Releasing for Android
+
+```bash
+revopush release-react rn2_android android -d appcenter-Staging
+```
+
+**What Happens:**
+- Bundles your JavaScript code.
+- Uploads the bundle and assets to Revopush.
+- Releases the update to the **appcenter-Staging** deployment of **rn2_android**.
+
+**Success Message:**
+```
+Successfully released an update to the "appcenter-Staging" deployment of the "rn2_android" app.
+```
+
+**Additional Options:**
+For more customization, view all options:
+```bash
+revopush release-react -h
+```
+```
+
+### 10. **Consolidate Summary and Resources**
+- **Recap Key Points:** Briefly summarize the migration or setup process.
+- **Provide Clear Resource Links:** Ensure all resources are easily accessible and clearly labeled.
+
+**Revised Summary Example:**
+```markdown
+### 7. Summary
+
+Migrating your OTA updates from Appcenter to Revopush is straightforward with our CLI tools. Whether you're migrating existing applications or setting up new ones, Revopush offers a seamless experience with familiar commands and robust features.
+
+**Quick Command Reference:**
+
+| Appcenter Command                     | Revopush Command                      | Description                                    |
+|---------------------------------------|---------------------------------------|------------------------------------------------|
+| `appcenter login`                     | `revopush login`                      | Log in to the CLI                               |
+| `appcenter codepush deployment`       | `revopush deployment`                  | Manage app deployments                          |
+| `appcenter apps`                      | `revopush app`                         | Manage your applications                         |
+| `appcenter codepush release-react`    | `revopush release-react`               | Release a React Native update                     |
+| `appcenter logout`                    | `revopush logout`                      | Log out of the CLI                               |
+
+**Helpful Resources:**
+- [React Native CodePush GitHub](https://github.com/microsoft/react-native-code-push)
+- [React Native Client SDK Documentation](https://docs.revopush.org/client-sdk)
+- [Best Practices for Multi-Deployment Testing](https://docs.revopush.org/multi-deployment-testing)
+- **Support:** Reach out to us at [support@revopush.org](mailto:support@revopush.org) for any questions or feedback.
+```
+
+### 11. **General Style Improvements**
+- **Consistent Terminology:** Ensure terms like "deployments," "applications," and "CLI" are used consistently.
+- **Active Voice:** Use active voice to make instructions clearer (e.g., "Run this command" instead of "This command should be run").
+- **Avoid Redundancy:** Remove repetitive information to keep the guide concise.
+
+### 12. **Add a Troubleshooting Section**
+- **Common Issues:** Address frequent problems users might encounter during migration or setup.
+- **Solutions and Tips:** Provide clear solutions or point to resources where users can get help.
+
+**Example Troubleshooting Section:**
+```markdown
+### 8. Troubleshooting
+
+**Issue:** Unable to install Revopush CLI.
+- **Solution:** Ensure you have the latest version of npm installed. Run `npm install -g npm@latest` and try installing the CLI again.
+
+**Issue:** Deployment keys not recognized.
+- **Solution:** Double-check that you've copied the correct keys from Appcenter and added them to Revopush. Use `revopush deployment ls <app_name> -k` to verify.
+
+**Need More Help?**
+Contact our support team at [support@revopush.org](mailto:support@revopush.org) or visit our [documentation](https://docs.revopush.org).
+```
+
+### 13. **Ensure Accessibility**
+- **Readable Fonts and Colors:** If presenting this guide on a website, ensure the text is easily readable with appropriate font sizes and color contrasts.
+- **Alt Text for Images:** If adding screenshots, include descriptive alt text for accessibility.
+
+### 14. **Test the Guide**
+- **User Feedback:** Have someone unfamiliar with the process follow the guide to identify confusing sections.
+- **Iterate Based on Feedback:** Use the feedback to make necessary adjustments for clarity and simplicity.
+
+---
+
+Implementing these suggestions will make your guide more user-friendly, ensuring that new users can effortlessly understand and follow the process of installing the Revopush CLI and migrating their OTA updates from Appcenter.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revopush/code-push-cli",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Management CLI for the CodePush service",
   "main": "./script/cli.js",
   "scripts": {