Merge pull request rangle#367 from sumitarora/docs-update

sumitarora · sumitarora · commit 666e04f1e3b2 · 2016-05-02T13:43:23.000-04:00
updating readme for release
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 [![Circle CI](https://circleci.com/gh/rangle/augury.svg?style=svg)](https://circleci.com/gh/rangle/augury) [![Slack Status](https://augury-slack.herokuapp.com/badge.svg)](https://augury-slack.herokuapp.com)
 [![Stories in Ready](https://badge.waffle.io/rangle/augury.svg?label=ready&title=Ready)](https://waffle.io/rangle/augury)
 
-Augury is a Google Chrome Dev Tools extension for debugging Angular 2 applications. Treat this as a "developer preview". Until the official Chrome Web Store release, please follow the [instructions below](#getting-the-extension) to install it. It's actually quite easy.
+[Augury](https://augury.angular.io/) is a Google Chrome Dev Tools extension for debugging Angular 2 applications. You can install the extension from [Chrome Store](https://chrome.google.com/webstore/detail/augury/elgalmkoelokbchhkhacckoklkejnhcd).
 
 ![Screenshot of Augury](assets/screenloop.gif)
 
@@ -16,22 +16,6 @@ Currently works with applications built in [Angular 2.0.0-beta.15](https://githu
 
 If you want to contribute or need help getting started, [join us on Slack](https://augury-slack.herokuapp.com).
 
-## Getting the Extension
-
-You can get the extension in two ways:
-
-1. If you just want to use the extension you can get the latest master build, which is packaged and hosted on every successful build of master branch on CircleCI
- * To download the latest build go to [Batarangle.io](http://batarangle.io) and click install
- * After download is complete go to Chrome Extensions `chrome://extensions` in the Chrome
- * Drag and Drop the downloaded package to install the extension
-
-2. If you want to download the source code and build it manually
- * Clone the repo and install all the dependencies required
- * Run command `npm run pack`
- * This will generate `batarangle.crx` in the source folder
- * Then go to Chrome Extensions `chrome://extensions` in the Chrome
- * Drag and Drop the bundled package to install the extension
-
 ## Development Environment
 
 To develop this extension, the following environment is used:
@@ -41,16 +25,16 @@ To develop this extension, the following environment is used:
 * TypeScript 1.7.5
 * typings 0.6.8
 
-## Trying out the extension
+## Building & Installing Locally
 
 1. Clone this repository: `git clone git://github.com/rangle/augury`.
 2. Run `npm install`.
-3. Run `npm run build` (errors related to typing files conflicts can be ignore for now).
+3. Run `npm run build`.
 4. Navigate to chrome://extensions and enable Developer Mode.
 5. Choose "Load unpacked extension".
 6. In the dialog, open the directory you just cloned.
 
-To try out with an example application, refer to instructions in [README](./example-apps/todo-mvc-example/README.md).
+To try out the extension with an example application, refer to instructions in [README](./example-apps/kitchen-sink-example/README.md).
 
 ## Running Tests
 
@@ -65,17 +49,13 @@ To execute all unit tests, run `npm test`. It bundles up all files that match `*
 - `start` Clean build and run webpack in watch mode
 - `test` Bundle all *.test.ts and run it through a headless browser
 - `prepack` Run npm build before running npm pack
-- `pack` Packages the extension and create chrome build batarangle.crx
+- `pack` Packages the extension and create chrome build augury.crx
 
 ## Developer Information
 
 - [Developer guide](https://github.com/rangle/augury/wiki)
 - [Contributing guidelines](CONTRIBUTING.md)
 - [Architecture of this extension](./docs/ARCHITECTURE.md)
 
-## Future Plans
-
-We are working hard towards [the official release](https://github.com/rangle/augury/releases). But in the meantime, you can take a look at our [milestones](https://github.com/rangle/augury/milestones) to see what new features are in place.
-
 ## License
 [MIT](LICENSE)
diff --git a/manifest.json b/manifest.json
@@ -1,7 +1,7 @@
 {
   "name": "Augury",
   "short_name": "Augury",
-  "version": "0.0.9",
+  "version": "1.0.0",
   "description": "Extends the Developer Tools, adding tools for debugging and profiling Angular 2.0 applications.",
   "permissions": [
     "tabs",
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "augury",
-  "version": "0.0.9",
+  "version": "1.0.0",
   "description": "Chrome Developer Tools Extension for inspecting Angular 2.0 applications",
   "repository": {
     "type": "git",
diff --git a/popup.html b/popup.html
@@ -168,7 +168,7 @@ <h1>
 
       <div class="modal_content">
         <p>
-          Augury is a Google Chrome Dev Tool extension for debugging Angular 2 applications. Treat this as a "developer preview". Until the official release, please follow instructions on github to build the tool locally and install it from the source. It's actually quite easy!
+          Augury is a Google Chrome Dev Tool extension for debugging Angular 2 applications. Currently works with applications built in Angular 2.0.0-beta.15.
         </p>
       </div>
 
@@ -178,10 +178,10 @@ <h1>
             <a target="_blank" href="https://github.com/rangle/augury" class="icon github"><span>Github</span></a>
           </div>
           <div class="flex website">
-            <a target="_blank" href="http://rangle.github.io/batarangle-io/" class="icon"><span>Website</span></a>
+            <a target="_blank" href="https://augury.angular.io/" class="icon"><span>Website</span></a>
           </div>
           <div class="flex contribute">
-            <a target="_blank" href="https://github.com/rangle/augury" class="icon"><span>Contribute</span></a>
+            <a target="_blank" href="https://github.com/rangle/augury/blob/master/CONTRIBUTING.md" class="icon"><span>Contribute</span></a>
           </div>
         </div>
       </div>

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "Augury",`
`3`	`3`	`"short_name": "Augury",`
`4`		`- "version": "0.0.9",`
	`4`	`+ "version": "1.0.0",`
`5`	`5`	`"description": "Extends the Developer Tools, adding tools for debugging and profiling Angular 2.0 applications.",`
`6`	`6`	`"permissions": [`
`7`	`7`	`"tabs",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "augury",`
`3`		`- "version": "0.0.9",`
	`3`	`+ "version": "1.0.0",`
`4`	`4`	`"description": "Chrome Developer Tools Extension for inspecting Angular 2.0 applications",`
`5`	`5`	`"repository": {`
`6`	`6`	`"type": "git",`