This repository was archived by the owner on May 20, 2025. It is now read-only.
Merged
Conversation
Contributor
|
There are a few places where it should be 'retrieves' instead of 'retreives' |
sdk/README.md
Outdated
| @@ -0,0 +1,86 @@ | |||
| # Node.js SDK for CodePush | |||
|
|
|||
| A JavaScript library for programatically managing your CodePush account (e.g. creating apps, promoting releases), which allows authoring Node.js-based build and/or deployment scripts, without needing to shell out to the [CLI](https://github.com/Microsoft/code-push/blob/master/cli/README.md). | |||
|
|
||
| - __getDeploymentMetrics(appName: string, deploymentName): Promise<DeploymentMetrics>__ - Retreives the installation metrics for the specified app deployment. | ||
|
|
||
| - __getDeployments(appName: string): Promose<Deployment[]>__ - Retrieves the list of deployments associated with the specified app. |
|
|
||
| - __rollback(appName: string, deploymentName: string, targetRelease?: string): Promise<void>__ - Rolls back the latest release within the specified deployment. Optionally allows you to target a specific release in the deployment's history, as opposed to rolling to the previous release. | ||
|
|
||
| - __transferApp(appName: string, email: string): Promise<void>__ - Transfers the ownership of the specified app to the specified account. No newline at end of file |
Contributor
There was a problem hiding this comment.
Do you think we should add clearDeployment in here as well, or wait for the changes to go through?
Member
Author
There was a problem hiding this comment.
This is simply documenting what is already in master, as well as what the production server accommodates. We can update the readme as new features get rolled in.
Contributor
|
Perfecto! |
README.md
Outdated
| [CodePush](https://microsoft.github.io/code-push) is a cloud service that enables Cordova and React Native developers to deploy mobile app updates directly to their users' devices. It works by acting as a central repository that developers can publish updates to (JS, HTML, CSS and images), and that apps can query for updates from (using provided client SDKs for [Cordova](https://github.com/Microsoft/cordova-plugin-code-push) and [React Native](https://github.com/Microsoft/react-native-code-push)). This allows you to have a more deterministic and direct engagement model with your userbase, when addressing bugs and/or adding small features that don't require you to re-build a binary and re-distribute it through the respective app stores. | ||
|
|
||
| This repo includes the [management CLI](http://microsoft.github.io/code-push/docs/cli.html) as well as some shared code that is used by both the Cordova and React Native client SDKs. To get started using CodePush, refer to our [documentation](http://microsoft.github.io/code-push/index.html#getting_started), otherwise, read the following steps if you'd like to build/contribute to the project from source. | ||
| This repo includes the [management CLI](https://github.com/Microsoft/code-push/tree/master/cli) and [Node.js management SDK](https://github.com/Microsoft/code-push/tree/master/sdk), which allow you to manage and automate the needs of your Cordova and React Native apps. To get started using CodePush, refer to our [documentation](http://microsoft.github.io/code-push/index.html#getting_started), otherwise, read the following steps if you'd like to build/contribute to the project from source. |
Contributor
|
LGTM |
lostintangent
added a commit
that referenced
this pull request
Mar 8, 2016
Initial checkin for SDK readme
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
We can expand on this later, but this provides the basic getting started and reference docs for users wanting to take advantage of the new Node.js management SDK.