diff --git a/README.md b/README.md index 7792f73..17d5b93 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ -CodePush -=== +# CodePush -Dev Setup ---- +[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](http://github.com/cordova-plugin-code-push) and [React Native](http://github.com/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, refer to our [documentation](http://microsoft.github.io/code-push/index.html#getting_started). + +## Dev Setup * Install [Node.js](https://nodejs.org/) * Install [Git](http://www.git-scm.com/) @@ -26,4 +28,4 @@ To test just one of the projects (e.g. cli or sdk), run `gulp test-cli` or `gulp * Use double quotes for strings * Use four space tabs -* Use `camelCase` for local variables and imported modules, `PascalCase` for types, and `dash-case` for file names +* Use `camelCase` for local variables and imported modules, `PascalCase` for types, and `dash-case` for file names \ No newline at end of file