Update the README

hdeshev · hdeshev · commit 5adb1725a1d3 · 2015-11-27T18:49:34.000+02:00
diff --git a/README.md b/README.md
@@ -10,20 +10,19 @@ The project bundles the NativeScript modules and Angular as source code dependen
 $ git submodule update --init
 ```
 
+# Prerequisites
+
+Install your native toolchain and NativeScript as described in the docs:
+
+https://docs.nativescript.org/setup/quick-setup
+
+
 ## Install dependencies
 
 ```
 $ npm install -g grunt-cli
-$ npm install -g tsd
-$ npm install -g nativescript
 ```
 
-You may need to configure your `tsd` GitHub access token to avoid rate-limit-related download errors. See the token installation instructions in the `.tsdrc` section [here](https://github.com/DefinitelyTyped/tsd#tsdrc).
-
-You will also need the [Android SDK](https://developer.android.com/sdk/) to build this project. Install it manually before continuing with the next steps.
-
-Then install the NativeScript tools according to: [this article](http://docs.nativescript.org/setup/quick-setup).
-
 Then install the needed NPM packages:
 
 ```
@@ -33,56 +32,48 @@ $ npm install
 ## Compile and prepare NativeScript and Angular
 
 ```
-$ (cd deps/angular/modules/angular2 && tsd reinstall)
 $ grunt prepare
 ```
 
 ## Initialize the test NativeScript app (ng-sample)
 
 ```
-$ grunt shell:ngSampleInit
+$ cd ng-sample
+$ grunt prepare
 ```
 
-## Compile the app and update its `./src` dir:
+The latter installs the `angular2` and `tns-core-modules` packages that you just built by running `grunt prepare` step in the project root.
+
+## Compile the ng-sample app
 
 ```
-$ grunt ng-sample
+$ grunt app
 ```
 
 # Developer workflow:
 
-1. Make some changes to the app or `src/nativescript-angular`
-2. Navigate to the ng-sample subdir: `$ cd ng-sample`
+1. Make changes to `src/nativescript-angular`, and rebuild with `grunt build`. If succesful, you should get a npm package in the project root.
+2. Navigate to the ng-sample subdir: `$ cd ng-sample`. Make some changes to the app or `../src/nativescript-angular`.
 2. Compile app: `$ grunt app`
-3. Run in emulator `$ tns emulate android --avd <YOUR-AVD>`
+3. Run with `$ tns run android` or `$ tns run ios`
 
 Protip: combine #2 and #3 above in a single command run from the project root directory (works only on Unixy shells):
 
 ```
-$ (cd ng-sample && grunt app && tns emulate android --avd nexus4-x64)
+$ grunt app && tns run android
 ```
 
 On Windows, you can wrap those commands in a BAT file.
 
-# Finding your way around
-
-1. The `./src/nativescript-angular` folder holds the integration source code.
-2. The sample app below `ng-sample` is assembled by copying typescript dependencies in its `src` folder:
-    * angular2 source code
-    * nativescript-angular code
-    * NativeScript typings: typings/nativescript
-3. All required JavaScript packages (including compiled NativeScript modules) are copied to `ng-sample/app/tns_modules`
-
-# How the integration code works
-
-1. Use the Angular Parse5DomAdapter to parse component markup.
-2. Provide a custom renderer (`NativeScriptRenderer`) that works with the parsed DOM and creates NativeScript UI elements. Only limited number of visual elements supported so far.
+Note that you should never change files in `ng-sample/src/nativescript-angular/` as they are overwritten with the reference sources in `src/nativescript-angular` on every `grunt app` run.
 
 # Watch the video explaining Angular 2 and NativeScript
 [NativeScript session on AngularConnect conference](https://www.youtube.com/watch?v=4SbiiyRSIwo)
 
 # Explore the examples
 
+The `ng-sample` app is meant for testing stuff while developing the renderer code, and isn't the best example out there. You can take a look at these sample apps that use the published builds from npm:
+
 * [Hello world starter](https://github.com/NativeScript/template-hello-world-ng)
 * [TodoMVC sample implementation](https://github.com/NativeScript/sample-ng-todomvc)
 
@@ -91,4 +82,3 @@ On Windows, you can wrap those commands in a BAT file.
 1. There are certain issues with the Parse5DomAdapter and we'll likely need to provide our own later on:
   * Element and attribute names always get lowercased.
   * Self-closing elements (`<Label text="Name" /><Button text="Save" />`) get parsed wrong (in this case Button gets parsed as a Label child.
-2. The renderer implementation is by no means complete: we are still need to support view (de)hydration, DOM text updates, event dispatching, actions, etc.
