Updating readme and version bump

Author: mattpodwysocki

bower.json

@@ -1,7 +1,7 @@
 {
   "name": "rx-angular",
-  "version": "0.0.2",
-  "main": "rx.dom.js",
+  "version": "0.0.3",
+  "main": "rx.angular.js",
   "dependencies": {
     "rxjs": "*"
   },

docs/readme.md

@@ -1,4 +1,4 @@
-# rx.angular.js <sup>v0.0.1</sup>
+# rx.angular.js <sup>v0.0.3</sup>
 
 Reactive Extensions (Rx) is a library for composing asynchronous and event-based programs using observable sequences and Array#extras style operators.
 
@@ -16,6 +16,85 @@ Factories:
 - [`rx`](#rx)
 - [`observeOnScope`](#observeonscopescope-watchexpression-objectequality)
 
+Observable Methods:
+- [`safeApply`](#safeapplyscope-fn)
+
+[`$rootScope`](http://docs.angularjs.org/api/ng.$rootScope) Methods:
+- [`$createObservableFunction`](#createobservablefunctionfunctionname-listener)
+- ['$toObservable'](#toobservablewatchexpression-objectequality)
+
+* * *
+
+### <a id="rx"></a>`rx`
+<a href="#rx">#</a> [&#x24C8;](https://github.com/Reactive-Extensions/rx.angular.js/blob/master/src/factory.js#L1-L6 "View in source") 
+
+Creates a factory for using RxJS.
+
+#### Returns
+*(Rx)*: The root of RxJS
+
+#### Example
+```js
+angular.module('example', ['rx'])
+    .controller('AppCtrl', function($scope, rx) {
+
+        $scope.counter = 0;
+
+        rx.Observable.interval(1000)
+            .safeApply(
+                $scope, 
+                function (x) {
+                    $scope.counter = x;
+                })
+            .subscribe();
+
+    });
+```
+
+### Location
+
+File:
+- /src/factory.js
+
+Dist:
+- rx.angular.js
+
 * * *
 
-# TBD
+### <a id="observeonscopescope-watchexpression-objectequality"></a>`observeOnScope(scope, watchExpression, [objectEquality])`
+<a href="#observeonscopescope-watchexpression-objectequality">#</a> [&#x24C8;](https://github.com/Reactive-Extensions/rx.angular.js/blob/master/src/observeronscope.js#L1-L13 "View in source") 
+
+Creates a factory which allows the user to observe a property on a given scope to check for old and new values.
+
+#### Arguments
+1. `scope` *(Scope)*: The scope to apply the watch function.
+2. `watchExpression`: Expression that is evaluated on each `$digest` cycle. A change in the return value triggers a call to the listener.
+    - `string`: Evaluated as expression
+    - `function(scope)`: called with current scope as a parameter.
+3. `[objectEquality]`: *(Function)*: Compare object for equality rather than for reference.
+
+#### Returns
+*(Rx)*: The root of RxJS
+
+#### Example
+```js
+angular.module('observeOnScopeApp', ['rx'])
+    .controller('AppCtrl', function($scope, observeOnScope) {
+        
+        observeOnScope($scope, 'name').subscribe(function(change) {
+            $scope.observedChange = change;
+            $scope.newValue = change.newValue;
+            $scope.oldValue = change.oldValue;
+        });
+    });
+```
+
+### Location
+
+File:
+- /src/observeronscope.js
+
+Dist:
+- rx.angular.js
+
+* * *

nuget/RxJS-Bridges-Angular/RxJS-Bridges-Angular.nuspec

@@ -4,7 +4,7 @@
     <id>RxJS-Bridges-Angular</id>
     <title>Reactive Extensions for JavaScript - Bridges to AngularJS</title>
     <!-- Automatically updated by build, keeping fixed dev build number here in case of local build -->
-    <version>0.0.2</version>
+    <version>0.0.3</version>
     <authors>MS Open Tech</authors>
     <description>This project provides Reactive Extensions for JavaScript (RxJS) bindings for AngularJS.</description>
     <projectUrl>https://github.com/Reactive-Extensions/rx.angular.js</projectUrl>

package.json

@@ -2,7 +2,7 @@
   "name": "rx-angular",
   "title": "The Reactive Extensions Bindings for the AngularJS.",
   "description": "Library for bridging between RxJS and AngularJS.",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "homepage": "https://github.com/Reactive-Extensions/rx.angular.js",
   "author": {
     "name": "MS Open Tech"

readme.md

@@ -5,30 +5,79 @@ This library serves as a bridge between the [Reactive Extensions for JavaScript
 With this library, you will be able to do such things as easily watch values as they change, as observable sequences such as:
 
 ```js
-angular.module('observeOnScopeApp', ['rx'])
-	.controller('AppCtrl', function($scope, observeOnScope) {
-
-		// Listen for changes on the name
-		observeOnScope($scope, 'name').subscribe(function(change) {
-			$scope.observedChange = change;
-			$scope.newValue = change.newValue;
-			$scope.oldValue = change.oldValue;
-		});
-	});
+angular.module('example', ['rx'])
+    .controller('AppCtrl', function($scope, observeOnScope) {
+
+        // Listen for changes on the name
+        observeOnScope($scope, 'name').subscribe(function(change) {
+            $scope.observedChange = change;
+            $scope.newValue = change.newValue;
+            $scope.oldValue = change.oldValue;
+        });
+    });
 ```
 
 And with your HTML markup you can use it like this:
 
-	<div class="container" ng-app="observeOnScopeApp" ng-controller="AppCtrl">
-	  <h2>Reactive Angular</h2>
-	  <ul class="list-unstyled">
-	    <li>observedChange {{observedChange}}</li>
-	    <li>newValue: {{newValue}</li>
-	    <li>oldValue: {{oldValue}}</li>
-	  </ul>  
-	  
-	  <input type="text" ng-model="name" />
-	</div>
+    <div class="container" ng-app="example" ng-controller="AppCtrl">
+      <h2>Reactive Angular</h2>
+      <ul class="list-unstyled">
+        <li>observedChange {{observedChange}}</li>
+        <li>newValue: {{newValue}</li>
+        <li>oldValue: {{oldValue}}</li>
+      </ul>  
+      
+      <input type="text" ng-model="name" />
+    </div>
+
+Another example is where we can create an Observable sequence from such things ng-click expressions where we can search Wikipedia:
+
+```js
+angular.module('example', ['rx'])
+    .controller('AppCtrl', function($scope, $http, rx) {
+
+        function searchWikipedia (term) {
+            var deferred = $http({
+                    url: "http://en.wikipedia.org/w/api.php?&callback=JSON_CALLBACK",
+                    method: "jsonp",
+                    params: {
+                        action: "opensearch",
+                        search: term,
+                        format: "json"
+                    }
+                });
+
+            return rx.Observable
+                .fromPromise(deferred)
+                .map(function(response){ return response.data[1]; });                
+        }
+
+        $scope.search = '';
+        $scope.results = [];
+
+        /*
+            Creates a "click" function which is an observable sequence instead of just a function.
+        */
+        $scope.$createObservableFunction('click')
+            .map(function () { return $scope.search; })
+            .flatMapLatest(searchWikipedia)
+            .subscribe(function(results) {
+                $scope.results = results;
+            });
+    });
+```
+
+And the HTML markup you can simply just use a ng-click directive much as you have before, but now it is an Observable sequence.
+
+    <div class="container" ng-app="example" ng-controller="AppCtrl">
+
+        <input type="text" ng-model="search">
+        <button ng-click="click()">Search</button>
+
+        <ul>
+            <li ng-repeat="result in results">{{result}}</li>
+        </ul>
+    </div>
 
 This only scratches the surface of what is possible when you combine the two libraries together.
 
@@ -45,6 +94,23 @@ There are a number of ways to get started with RxJS.
     git clone https://github.com/Reactive-Extensions/rx.angular.js.git
     cd ./rx.angular.js
 
+### Installing with [NPM](https://npmjs.org/)
+
+    npm install rx-angular
+    npm install -g rx-angular
+
+### Installing with [Bower](http://bower.io/)
+
+    bower install rx-angular
+
+### Installing with [Jam](http://jamjs.org/)
+    
+    jam install rx-angular
+
+### Installing All of RxJS via [NuGet](http://nuget.org/)
+
+    Install-Package RxJS-Bridges-Angular
+
 ## Contributing ##
 
 There are lots of ways to [contribute](https://github.com/Reactive-Extensions/rx.angular.js/wiki/Contributions) to the project, and we appreciate our [contributors](https://github.com/Reactive-Extensions/rx.angular.js/wiki/Contributors).