From ef31bf51d357ad86c1c637de833fbee27a588c33 Mon Sep 17 00:00:00 2001 From: Jonathan Carter Date: Tue, 8 Mar 2016 14:35:43 -0800 Subject: [PATCH] Small doc tweaks --- cli/README.md | 3 ++- sdk/README.md | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/cli/README.md b/cli/README.md index e46817c1..b46c0572 100644 --- a/cli/README.md +++ b/cli/README.md @@ -129,6 +129,7 @@ Inversely, that means that an app collaborator cannot do any of the following: 1. Rename or delete the app 1. Transfer ownership of the app 1. Create, rename or delete new deployments within the app +1. Clear a deployment's release history 1. Add or remove collaborators from the app (*) *NOTE: A developer can remove him/herself as a collaborator from an app that was shared with them.* @@ -434,4 +435,4 @@ You can clear the release history associated with a deployment using the followi code-push deployment clear ``` -After running this command, client devices configured to receive updates from this deployment using its associated deployment key will no longer receive those updates that have been cleared. This command is irreversible, and therefore should not be used in a production deployment. +After running this command, client devices configured to receive updates using its associated deployment key will no longer receive the updates that have been cleared. This command is irreversible, and therefore should not be used in a production deployment. \ No newline at end of file diff --git a/sdk/README.md b/sdk/README.md index 189b4b97..c3eecb7f 100644 --- a/sdk/README.md +++ b/sdk/README.md @@ -47,6 +47,8 @@ The `code-push` module exports a single class (typically referred to as `CodePus - __addDeployment(appName: string, deploymentName: string): Promise<Deployment>__ - Creates a new deployment with the specified name, and associated with the specified app. +- __clearDeploymentHistory(appName: string, deploymentName: string): Promise<void>__ - Clears the release history associated with the specified app deployment. + - __getAccessKey(accessKey: string): Promise<AccessKey>__ - Retrieves the metadata about the specific access key. - __getAccessKeys(): Promise<AccessKey[]>__ - Retrieves the list of access keys associated with your CodePush account.