Skip to content

Commit f7a1359

Browse files
committed
Update README.md
1 parent 8a76f1c commit f7a1359

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,19 @@ For Angular 2 see [ng2-redux](https://github.com/wbuchwalter/ng2-redux).
1111

1212
*ngRedux lets you easily connect your angular components with Redux.*
1313

14+
15+
## Table of Contents
16+
17+
- [Installation](#installation)
18+
- [Quick Start](#quick-start)
19+
- [API](#api)
20+
1421
## Installation
1522
```js
1623
npm install --save ng-redux
1724
```
1825

19-
## Overview
26+
## Quick Start
2027

2128
#### Initialization
2229

@@ -76,3 +83,10 @@ Connects an Angular component to Redux.
7683
#### Remarks
7784
If `$scope` is passed to `connect` as `target`, ngRedux will listen to the `$destroy` event and unsubscribe the change listener when it is triggered, you don't need to keep track of your subscribtions in this case.
7885
If anything else than `$scope` is passed as target, the responsability to unsubscribe correctly is deferred to the user.
86+
87+
## Store API
88+
All of redux's store methods (i.e. `dispatch`, `subscribe` and `getState`) are exposed by $ngRedux and can be accessed directly. For example:
89+
90+
```JS
91+
redux.bindActionCreators(actionCreator, $ngRedux.dispatch);
92+
```

0 commit comments

Comments
 (0)