Skip to content

Commit 266b992

Browse files
committed
chore: update README with about-this-fork section
1 parent cedc6a9 commit 266b992

2 files changed

Lines changed: 17 additions & 5 deletions

File tree

README-cn.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ CodePush是一个云服务,它能让Cordova和React Native的开发者将手
1010

1111
![CodePush CLI](https://cloud.githubusercontent.com/assets/116461/14505396/c97bdc78-016d-11e6-89da-3f3557f8b33d.png)
1212

13+
* [关于本仓库](#关于本仓库)
1314
* [安装](#安装)
1415
* [快速开始](#快速开始)
1516
* [创建账号](#创建账号)
@@ -29,10 +30,16 @@ CodePush是一个云服务,它能让Cordova和React Native的开发者将手
2930

3031
[[English Version]](./README.md)
3132

33+
## 关于本仓库
34+
本仓库的目的是为了适配开源的[code-push-server](https://github.com/shm-open/code-push-server). 因为官方的`code-push-cli`已经不再维护更新, 而`appcenter-cli`又无法登录自己搭建的`code-push-server`, 所以我们分叉了这个cli项目, 用来:
35+
- 适配开源`code-push-server`
36+
- 移植一些有价值的`appcenter-cli`的新功能, 比如针对React Native Hermes的支持
37+
- 保持项目依赖的更新
38+
3239
## 安装
3340

3441
* 安装 [Node.js](https://nodejs.org/)
35-
* 安装 CodePush CLI: `npm install -g code-push-cli`
42+
* 安装 CodePush CLI: `npm install -g @shm-open/code-push-cli`
3643

3744
## 快速开始
3845

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ CodePush is a cloud service that enables Cordova and React Native developers to
55
![CodePush CLI](https://cloud.githubusercontent.com/assets/245892/26749409/feb439f6-47d7-11e7-98fd-07d750b856d8.png)
66

77
<!-- CLI Catalog -->
8-
8+
* [About This Fork](#about-this-fork)
99
* [Installation](#installation)
1010
* [Getting Started](#getting-started)
1111
* [Account Management](#account-management)
@@ -31,11 +31,16 @@ CodePush is a cloud service that enables Cordova and React Native developers to
3131
[[Chinese version 中文版]](./README-cn.md)
3232

3333
<!-- CLI Catalog -->
34+
## About This Fork
35+
This fork is for open source [code-push-server](https://github.com/shm-open/code-push-server). Since the original `code-push-cli` is deprecated and `appcenter-cli` cannot work with self hosted `code-push-server`. We create this fork to:
36+
- work with open source `code-push-server`
37+
- port necessary new features from `appcenter-cli`, such as React Native Hermes support
38+
- keep dependencies up-to-date
3439

3540
## Installation
3641

3742
* Install [Node.js](https://nodejs.org/)
38-
* Install the CodePush CLI: `npm install -g code-push-cli`
43+
* Install the CodePush CLI: `npm install -g @shm-open/code-push-cli`
3944

4045
## Getting Started
4146

@@ -220,7 +225,7 @@ code-push collaborator ls <appName>
220225
The update to version 2.0.0.0 saw the removal of the `app transfer` command. You may still transfer ownership of your applications by managing the transfer through an organization. This requires that you visit [Mobile Center](https://mobile.azure.com) and execute a few steps.
221226

222227
1. Go to to [https://mobile.azure.com](https://mobile.azure.com) and create a new organization.
223-
2. Invite the person you to whom you wish to transfer the app to the organization. Once they have accepted the invitation change their access permissions to "Admin".
228+
2. Invite the person you to whom you wish to transfer the app to the organization. Once they have accepted the invitation change their access permissions to "Admin".
224229
3. Navigate to your app and click on the "Manage App" button (top right when on the "Getting Started" page for the app). Hit the Transfer button there to transfer the app to the org. Note that currently this operation cannot be reversed, although this will change in the future.
225230
4. Once your invitee has accepted, select the organization that you created and remove yourself from it.
226231

@@ -894,7 +899,7 @@ At the end of release command, the cli computes the bundle's content hash and pl
894899

895900
If you are planning to use this feature you need to do the following:
896901

897-
1. Produce new binary update including
902+
1. Produce new binary update including
898903
* updated codepush plugin supporting Code Signing
899904
* configure your code-push sdk to use your public key (please, refer relevent React Native SDK ([iOS](https://github.com/Microsoft/react-native-code-push/blob/master/docs/setup-ios.md#code-signing-setup), [Android](https://github.com/Microsoft/react-native-code-push/blob/master/docs/setup-android.md#code-signing-setup)) or [Cordova SDK](https://github.com/Microsoft/cordova-plugin-code-push#getting-started) sections for details)
900905
2. Produce a new CodePush update that targets the new binary version and specifies a `--privateKeyPath` (or simply `-k`) parameter value

0 commit comments

Comments
 (0)