diff --git a/docs/api.md b/docs/api.md index 83b144c..7fa3031 100644 --- a/docs/api.md +++ b/docs/api.md @@ -6,11 +6,11 @@ ### packageVersion -当前应用包的版本名。 +当前应用原生包的版本。其中android取自`versionName`字段(位于`android/build.gralde`中)。ios取自`CFBundleShortVersionString`字段(位于`ios/项目名/Info.plist`中)。 ### currentVersion -当前版本的Hash号。 +当前热更新版本(jsbundle文件)的Hash号。 ### isFirstTime @@ -24,7 +24,7 @@ 检查更新,返回值有三种情形: -1. `{expired: true}`:该应用包(原生部分)已过期,需要前往应用市场下载新的版本。 +1. `{expired: true}`:该应用原生包已过期,需要前往应用市场下载新的版本。 ``` { expired: true, @@ -35,7 +35,7 @@ 3. `{update: true}`:当前有新版本可以更新。info的`name`、`description`字段可 以用于提示用户,而`metaInfo`字段则可以根据你的需求自定义其它属性(如是否静默更新、 -是否强制更新等等)。另外还有几个字段,包含了完整更新包或补丁包的下载地址, +是否强制更新等等)。另外还有几个字段,包含了热更新文件的下载地址, ``` { update: true, @@ -43,7 +43,6 @@ hash: 'hash', description: '添加聊天功能\n修复商城页面BUG', metaInfo: '{"silent":true}', - updateUrl: 'http://update-packages.reactnative.cn/hash', pdiffUrl: 'http://update-packages.reactnative.cn/hash', diffUrl: 'http://update-packages.reactnative.cn/hash', } diff --git a/docs/cli.md b/docs/cli.md index 6e7b47b..489f883 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -4,7 +4,7 @@ ``` $ npm install -g react-native-update-cli -$ npm install --save react-native-update +$ npm install react-native-update ``` ## 使用 @@ -90,18 +90,18 @@ $ npm install --save react-native-update #### pushy packages -查看已经上传的包。这项操作也可以在网页管理端进行。 +查看已经上传的原生包。这项操作也可以在网页管理端进行。 - platform: ios|android 对应的平台 #### pushy publish -发布新的更新版本。 +发布新的热更新版本(ppk文件)。 - platform: ios|android 对应的平台 -- name: 当前版本的名字(版本号) -- description: 当前版本的描述信息,可以对用户进行展示 -- metaInfo: 当前版本的元信息,可以用来保存一些额外信息 +- name: 当前热更新版本的名字(版本号) +- description: 当前热更新版本的描述信息,可以对用户进行展示 +- metaInfo: 当前热更新版本的元信息,可以用来保存一些额外信息 #### pushy versions @@ -111,8 +111,8 @@ $ npm install --save react-native-update #### pushy update -为一个包版本绑定一个更新版本。这项操作也可以在网页管理端进行。 +为一个原生包版本绑定一个热更新版本。这项操作也可以在网页管理端进行。 - platform: ios|android 对应的平台 -- versionId: 要绑定的版本 ID -- packageId: 要绑定的包 ID +- versionId: 要绑定的热更新版本 ID +- packageId: 要绑定的原生包 ID diff --git a/docs/faq_advance.md b/docs/faq_advance.md index b01b797..9516a8f 100644 --- a/docs/faq_advance.md +++ b/docs/faq_advance.md @@ -57,7 +57,7 @@ 目前我们的热更新服务完全免费,但限制每个账号不超过3个应用;每个应用不超过10个活跃的包和100个活跃的热更新版本;每个应用每个月不超过10000次下载。iOS和Android版本记做不同的应用。 -已经移除的应用、包版本、热更新版本不在统计之列,所以你可以移除测试时产生的和已过期版本来更有效的利用空间。 +已经移除的应用、原生包版本、热更新版本不在统计之列,所以你可以移除测试时产生的和已过期版本来更有效的利用空间。 我们会在将来推出付费的升级版本,针对用户量较大、版本迭代较快的用户提供扩容方案。如果您有急迫的需求,可以[联系我们](https://reactnative.cn/about.html#content)。 diff --git a/docs/guide2.md b/docs/guide2.md index dd113da..33c05ba 100644 --- a/docs/guide2.md +++ b/docs/guide2.md @@ -25,7 +25,7 @@ const info = await checkUpdate(appKey) 返回的info有三种情况: -1. `{expired: true}`:该应用包(原生部分)已过期,需要前往应用市场下载新的版本。 +1. `{expired: true}`:该应用原生包已过期(已从pushy服务器中删除),开发者应该在pushy控制台添加一个更新下载链接,并自行提示用户下载。 2. `{upToDate: true}`:当前已经更新到最新,无需进行更新。 @@ -36,7 +36,7 @@ react-native-update会首先尝试耗费流量更少的更新方式。将info对 ## 切换版本 -downloadUpdate的返回值是一个hash字符串,它是当前版本的唯一标识。 +downloadUpdate的返回值是一个hash字符串,它是当前热更新版本的唯一标识。 你可以使用`switchVersion`函数立即切换版本(此时应用会立即重新加载),或者选择调用 `switchVersionLater`,让应用在下一次启动的时候再加载新的版本。 @@ -139,8 +139,8 @@ class MyProject extends Component { 这是版本一 {'\n'} - 当前包版本号: {packageVersion}{'\n'} - 当前版本Hash: {currentVersion||'(空)'}{'\n'} + 当前原生包版本号: {packageVersion}{'\n'} + 当前热更新版本Hash: {currentVersion||'(空)'}{'\n'} diff --git a/docs/guide3.md b/docs/guide3.md index 53092dd..2ecde94 100644 --- a/docs/guide3.md +++ b/docs/guide3.md @@ -16,7 +16,7 @@ $ pushy uploadIpa ``` -即可上传ipa以供后续版本比对之用。 +即可上传ipa以供后续版本比对之用。此ipa的`CFBundleShortVersionString`字段(位于`ios/项目名/Info.plist`中)会被记录为原生版本号`packageVersion`。 随后你可以选择往AppStore发布这个版本,也可以先通过Test flight等方法进行测试。 @@ -31,7 +31,7 @@ $ pushy uploadIpa $ pushy uploadApk android/app/build/outputs/apk/release/app-release.apk ``` -即可上传apk以供后续版本比对之用。 +即可上传apk以供后续版本比对之用。此apk的`versionName`字段(位于`android/build.gralde`中)会被记录为原生版本号`packageVersion`。 随后你可以选择往应用市场发布这个版本,也可以先往设备上直接安装这个apk文件以进行测试。 @@ -51,17 +51,17 @@ Would you like to publish it?(Y/N) ``` Uploading [========================================================] 100% 0.0s -Enter version name: <输入版本名字,如1.0.0-rc> -Enter description: <输入版本描述> +Enter version name: <输入热更新版本名字,如1.0.0-rc> +Enter description: <输入热更新版本描述> Enter meta info: {"ok":1} Ok. Would you like to bind packages to this version?(Y/N) ``` -此时版本已经提交到update服务,但用户暂时看不到此更新,你需要先将特定的包版本绑定到此热更新版本上。 +此时版本已经提交到update服务,但用户暂时看不到此更新,你需要先将特定的原生包版本绑定到此热更新版本上。 -此时输入Y立即绑定,你也可以在将来使用`pushy update --platform `来使得对应包版本的用户更新。 -除此以外,你还可以在网页端操作,简单的将对应的包版本拖到此版本下即可。 +此时输入Y立即绑定,你也可以在将来使用`pushy update --platform `来使得对应原生包版本的用户更新。 +除此以外,你还可以在网页端操作,简单的将对应的原生包版本拖到此热更新版本下即可。 ``` Offset 0 @@ -72,7 +72,7 @@ Enter versionId or page Up/page Down/Begin(U/D/B) <输入序号,U/D翻页,B回 1) 1.0(normal) - 3 FiWYm9lB (未命名) Total 1 packages. -Enter packageId: <输入包版本序号,序号就是上面列表中)前面的数字> +Enter packageId: <输入原生包版本序号,序号就是上面列表中)前面的数字> ``` 版本绑定完毕后,客户端就应当可以检查到更新并进行更新了。