updated readme links

test-unit-sauce
Brian Ford 12 years ago
parent 171033e958
commit f69222a7c6

@ -1,20 +1,10 @@
# AngularJS Batarang
## Getting it
Checkout my fork of AngularJS from Github:
git clone git://github.com/btford/angular.js.git
cd angular.js
git fetch origin extension
git checkout origin/extension
## Installation
You'll need [Google Chrome Canary](https://tools.google.com/dlpage/chromesxs) to use the extension.
1. Navigate to `chrome://flags/` in Canary, and enable "Experimental Extension APIs"
2. Navigate to `chrome://chrome/extensions/` and enable Developer Mode.
3. On the same page, click "Load unpacked extension" and choose the "extension" directory inside the repository that you just checked out.
1. [Download the packed extension](https://github.com/downloads/angular/angularjs-batarang/angularjs-batarang.crx)
2. Open the file (should open with Canary) and follow the prompts to install.
## Using the Batarang
First, navigate Chrome Canary to the AngularJS application that you want to debug. [Open the Developer Tools](https://developers.google.com/chrome-developer-tools/docs/overview#access). There should be an AngularJS icon. Click on it to open he AngularJS Batarang.
@ -23,7 +13,7 @@ First, navigate Chrome Canary to the AngularJS application that you want to debu
The Batarang has four tabs: Model, Performance, Options, and Help.
### Model
![Batarang screenshot](img/model-tree.png)
![Batarang screenshot](https://github.com/angular/angularjs-batarang/raw/master/img/model-tree.png)
Starting at the top of this tab, there is the root selection. If the application has only one `ng-app` declaration (as most applications do) then you will not see the option to change roots.
@ -31,7 +21,7 @@ Below that is a tree showing how scopes are nested, and which models are attache
### Performance
![Batarang performance tab screenshot](img/performance.png)
![Batarang performance tab screenshot](https://github.com/angular/angularjs-batarang/raw/master/img/performance.png)
The performance tab must be enabled separately because it causes code to be injected into AngularJS to track and report performance metrics. There is also an option to output performance metrics to the console.
@ -40,16 +30,16 @@ Below that is a tree of watched expressions, showing which expressions are attac
Underneath that is a graph showing the relative performance of all of the application's expressions. This graph will update as you interact with the application.
### Options
![Batarang options tab screenshot](img/options.png)
![Batarang options tab screenshot](https://github.com/angular/angularjs-batarang/raw/master/img/options.png)
Last, there is the options tab. The options tab has two checkboxes: one for "show scopes" and one for "show bindings." Each of these options, when enabled, highlights the respective feature of the application being debugged; scopes will have a red outline, and bindings will have a blue outline.
### Elements
![Batarang console screenshot](img/inspect.png)
![Batarang console screenshot](https://github.com/angular/angularjs-batarang/raw/master/img/inspect.png)
The Batarang also hooks into some of the existing features of the Chrome developer tools. For AngularJS applications, there is now a properties pane on in the Elements tab. Much like the model tree in the AngularJS tab, you can use this to inspect the models attached to a given element's scope.
### Console
![Batarang console screenshot](img/console.png)
![Batarang console screenshot](https://github.com/angular/angularjs-batarang/raw/master/img/console.png)
The Batarang exposes some convenient features to the Chrome developer tools console. To access the scope of an element selected in the Elements tab of the developer tools, in console, you can type `$scope`. If you change value of some model on `$scope` and want to have this change reflected in the running application, you need to call `$scope.$apply()` after making the change.