Skip to content

add info about running the demo #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 6, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,11 @@ Create an app *for each platform you target*. That way you can roll out release
> ⚠️ The `appname` must be unique, and should not contain dashes (`-`).

```shell
nativescript-code-push app add <appname> <platform>
nativescript-code-push app add <appname> <platform> nativescript

# examples:
nativescript-code-push app add MyAppIOS ios
nativescript-code-push app add MyAppAndroid android
nativescript-code-push app add MyAppIOS ios nativescript
nativescript-code-push app add MyAppAndroid android nativescript
```

> 💁‍♂️ This will show you your deployment keys you'll need when connecting to the CodePush server. If you want to list those keys at any later time, use `nativescript-code-push deployment ls <appName> --displayKeys`.
Expand Down Expand Up @@ -319,9 +319,9 @@ Which produces something like this:
|Label|Release Time|App Version|Mandatory|Description|Install Metrics
|---|---|---|---|---|---
|v2|an hour ago|1.0.0|Yes|Mandatory iOS version!|Active: 11% (2 of 19)
|||||Total: 2|
||||||Total: 2|
|v1|2 hours ago|1.0.0|No|Awesome iOS version!|Active: 26% (5 of 19)
|||||Total: 5|
||||||Total: 5|

### Give me the details of the current release!
This dumps the details of the most recent release for both the Staging and Production environments of your app:
Expand Down Expand Up @@ -364,6 +364,18 @@ Perform these steps once you've pushed an update and added the `sync` command to
- `$ tns run <platform>`. On an iOS *device* add the `--release` flag so LiveSync doesn't interfere.
- kill and restart the app after the update is installed

### Running the demo app
You may also play with CodePush by using its demo app. Here are the steps you need to perform in order to observe an app update:
- register with the service (`nativescript-code-push register`) and add the demo app to your account (`nativescript-code-push app add <appname> <platform> nativescript`)
- once the app is registered you will see its deployment keys in the console, use them to update the ones in the [demo](https://github.com/EddyVerbruggen/nativescript-code-push/blob/master/demo/demoapp/main-view-model.ts)
- go to src and run `npm run preparedemo` - this will build the plugin and add a reference to the demo app
- prepare an app that will be used as an "update version" (for example, uncomment one of the CODEPUSH labels and comment the APPSTORE label), then run `tns build <platform>`
- release the update (`nativescript-code-push release <appname> <platform>`)
- you can ensure it appears in the list with updates (`nativescript-code-push deployment history <appname> Staging`)
- prepare an app that will be used as an "official release version" (for example, comment the CODEPUSH label and uncomment the APPSTORE label), then run `tns run <platform>`
- when the app is deployed on the device, you should see the "official release version" along with information about an installed update
- close the app (and remove it from device's recent apps to ensure its next start will be a cold start) and run it again - you should now see the "update version" of the app

### Patching Update Metadata
After releasing an update, there may be scenarios where you need to modify one or more of the metadata attributes associated with it
(e.g. you forgot to mark a critical bug fix as mandatory.
Expand Down Expand Up @@ -536,4 +548,4 @@ Once you've logged in, any inferred and/or specified proxy settings are persiste
This allows you to continue using the CLI without needing to re-authenticate or re-specify your preferred proxy.
If at any time you want to start or stop using a proxy, simply logout, and then log back in with the newly desired settings.

</details>
</details>