docs: Added documentation on installing nightly builds (#22)

ngrx · May 3, 2017 · c40432d · c40432d
1 parent 95d288b
commit c40432d
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 17 deletions.
diff --git a/docs/effects/README.md b/docs/effects/README.md
@@ -1,4 +1,4 @@
-# Introduction
+# @ngrx/effects
 
 RxJS powered side effect model for @ngrx/store
 
@@ -9,13 +9,15 @@ RxJS powered side effect model for @ngrx/store
 - Provide new sources of actions to reduce state based on external
 interactions such as network requests, web socket messages and time-based events.
 
-## Installation
-
+### Installation
 Install @ngrx/effects from npm:
 
-```bash
-npm install @ngrx/effects --save
-```
+`npm install @ngrx/effects --save` OR `yarn add @ngrx/effects`
+
+
+### Nightly builds
+
+`npm install github:ngrx/effects-builds` OR `yarn add github:ngrx/effects-builds`
 
 ## Setup
 
@@ -29,7 +31,7 @@ effect to the store.
 
 ### Actions Observable
 
-The `Actions` observable represents an observable of all actions dispatched to the 
+The `Actions` observable represents an observable of all actions dispatched to the
 store. The `ofType` operator lets you filter for actions of a certain type in which you
 want to use to perform a side effect.
 

diff --git a/docs/router-store/README.md b/docs/router-store/README.md
@@ -5,9 +5,12 @@ Bindings to connect the Angular Router with @ngrx/store
 ### Installation
 Install @ngrx/router-store from npm:
 
-```bash
-npm install @ngrx/router-store --save
-```
+`npm install @ngrx/router-store --save` OR `yarn add @ngrx/router-store`
+
+
+### Nightly builds
+
+`npm install github:ngrx/router-store-builds` OR `yarn add github:ngrx/router-store-builds`
 
 During the navigation, before any guards or resolvers run, the router will dispatch a ROUTER_NAVIGATION action, which has the following signature:
 

diff --git a/docs/store-devtools/README.md b/docs/store-devtools/README.md
@@ -2,10 +2,15 @@
 
 Devtools for [@ngrx/store](../store/README.md).
 
-## Installation
-```bash
-npm install @ngrx/store-devtools --save-dev
-```
+### Installation
+Install @ngrx/store-devtools from npm:
+
+`npm install @ngrx/store-devtools --save` OR `yarn add @ngrx/store-devtools`
+
+
+### Nightly builds
+
+`npm install github:ngrx/store-devtools-builds` OR `yarn add github:ngrx/store-devtools-builds`
 
 
 ## Instrumentation

diff --git a/docs/store/README.md b/docs/store/README.md
@@ -1,4 +1,5 @@
 # @ngrx/store
+
 RxJS powered state management for Angular applications, inspired by Redux
 
 @ngrx/store is a controlled state container designed to help write performant, consistent applications
@@ -15,9 +16,13 @@ throughout your application.
 ### Installation
 Install @ngrx/store from npm:
 
-```bash
-npm install @ngrx/store --save
-```
+`npm install @ngrx/store --save` OR `yarn add @ngrx/store`
+
+
+### Nightly builds
+
+`npm install github:ngrx/store-builds` OR `yarn add github:ngrx/store-builds`
+
 
 ### Setup
 Create a reducer function for each data type you have in your application. The combination of these reducers will