<NME> README.md
<BEF> # ngrx-store-logger
Advanced logging for @ngrx/store applications, ported from [redux-logger](https://github.com/fcomb/redux-logger).

![ngrx-store-logger](http://imgur.com/Fm2qfb5.png)

## Dependencies
`ngrx-store-logger` depends on [@ngrx/store](https://github.com/ngrx/store) and [Angular 2](https://github.com/angular/angular).

## Usage
```bash
npm install ngrx-store-logger --save
```

1. Import `compose` and `combineReducers` from `@ngrx/store` and `@ngrx/core/compose`
2. Invoke the `storeLogger` function from ngrx-store-logger, passing appropriate options. 
3. Add `combineReducers` after `storeLogger` and invoke composed function with application reducers as an argument to `provideStore`.

```ts
import {bootstrap} from '@angular/platform-browser-dynamic';
import {TodoApp} from './todo-app';
import {provideStore, combineReducers} from "@ngrx/store";
import {compose} from "@ngrx/core/compose";
import {storeLogger} from "ngrx-store-logger";
import {todos, visibilityFilter} from './reducers';

export function main() {
  return bootstrap(TodoApp, [
      //taking all logging defaults
      //todos and visibilityFilter are just sample reducers
      provideStore(
        compose(
            storeLogger(), 
            combineReducers
        )({todos, visibilityFilter})
      ),
  ])
  .catch(err => console.error(err));
}

document.addEventListener('DOMContentLoaded', main);
```

## API
### `storeLogger(options : LoggerOptions  = {}) : Reducer`
Initializes logger with appropriate options (logical defaults if no options supplied)
*Returns a meta-reducer*

#### Arguments
* `options` \(*Object*): Available logger options

##### Options

``` ts
interface LoggerOptions {
    level? : 'log' | 'console' | 'warn' | 'error' | 'info'; //default log
    collapsed? : boolean; //Should log group be collapsed? default: false
    duration? : boolean; //Print duration with action? default: true
    timestamp? : boolean; //Print timestamp with action? default: true
    filter?: {
      whitelist?: string[], // Only print actions included in this list - has priority over blacklist
      blacklist?: string[] // Only print actions that are NOT included in this list
    }
    stateTransformer? : (state : Object) => Object; //Transform state before print default: state => state
    actionTransformer? : (actn : Object) => Object; //Transform action before print default: actn => actn
    colors? : {
        title: (action : Object) => string;
        prevState: (prevState : Object) => string;
        action: (action: Object) => string;
        nextState: (nextState : Object) => string;
        error: (error: any, prevState: Object) => string;
    }
}
```

### Filtering
#### Whitelist
Only actions included in the list will be printed
Example:
``` ts
const options: LoggerOptions = {
  filter: {
    whitelist: ['set-value']
  }
}
storeLogger(options) : Reducer
```
With this setup, only action *set-value* will be logged

#### Blacklist
Action included in the blacklist will not be printed
Example:
``` ts
const options: LoggerOptions = {
  filter: {
    blacklist: ['set-value']
  }
}
storeLogger(options) : Reducer
```
With this setup, all actions except *set-value* will be printed

*Note*: Whitelist takes precedence over blacklist. If both are defined, only whitelist will be considered

<MSG> updated readme for ngrx4
<DFF> @@ -4,40 +4,41 @@ Advanced logging for @ngrx/store applications, ported from [redux-logger](https:
 ![ngrx-store-logger](http://imgur.com/Fm2qfb5.png)
 
 ## Dependencies
-`ngrx-store-logger` depends on [@ngrx/store](https://github.com/ngrx/store) and [Angular 2](https://github.com/angular/angular).
+`ngrx-store-logger` depends on [@ngrx/store](https://github.com/ngrx/store) and [Angular 2+](https://github.com/angular/angular).
 
 ## Usage
 ```bash
 npm install ngrx-store-logger --save
 ```
-
-1. Import `compose` and `combineReducers` from `@ngrx/store` and `@ngrx/core/compose`
-2. Invoke the `storeLogger` function from ngrx-store-logger, passing appropriate options. 
-3. Add `combineReducers` after `storeLogger` and invoke composed function with application reducers as an argument to `provideStore`.
+**UPDATED FOR NGRX 4**
+1. Import `ngrx-store-logger`
+2. Wrap in a function 
+3. Include in your meta-reducers in `Store.forRoot` call.
 
 ```ts
-import {bootstrap} from '@angular/platform-browser-dynamic';
-import {TodoApp} from './todo-app';
-import {provideStore, combineReducers} from "@ngrx/store";
-import {compose} from "@ngrx/core/compose";
-import {storeLogger} from "ngrx-store-logger";
-import {todos, visibilityFilter} from './reducers';
+import { NgModule } from '@angular/core';
+import { BrowserModule } from '@angular/platform-browser';
+import { StoreModule, ActionReducer } from '@ngrx/store';
+import { storeLogger } from 'ngrx-store-logger';
+import { reducers } from './reducers';
 
-export function main() {
-  return bootstrap(TodoApp, [
-      //taking all logging defaults
-      //todos and visibilityFilter are just sample reducers
-      provideStore(
-        compose(
-            storeLogger(), 
-            combineReducers
-        )({todos, visibilityFilter})
-      ),
-  ])
-  .catch(err => console.error(err));
+export function logger(reducer: ActionReducer<State>): any {
+  // default, no options
+  return storeLogger()(reducer);
 }
 
-document.addEventListener('DOMContentLoaded', main);
+export const metaReducers = environment.production ? [] : [logger];
+
+@NgModule({
+  imports: [
+    BrowserModule,
+    StoreModule.forRoot(
+        reducers,
+        {metaReducers}
+    )
+  ]
+})
+export class MyAppModule {}
 ```
 
 ## API

updated readme for ngrx4