update readme

README.md

@@ -16,9 +16,24 @@ This project is an exploration of possible ways of splitting responsibility duri
 
 ## Links
 
- - [Documentation][doc-link]
+#### Showcase
+
+ - [Documentation Site][doc-link]
  - [Documentation Source](https://github.com/yeojz/react-form-addons/tree/master/site)
 
+#### Core Methods
+
+ - [compose](https://yeojz.github.io/react-form-addons#compose)
+ - [withProps](https://yeojz.github.io/react-form-addons#withProps)
+ - [withState](https://yeojz.github.io/react-form-addons#withState)
+ - [withSideEffects](https://yeojz.github.io/react-form-addons#withSideEffects)
+ - [withValidation](https://yeojz.github.io/react-form-addons#withValidation)
+ - [branch](https://yeojz.github.io/react-form-addons#branch)
+ - [collection](https://yeojz.github.io/react-form-addons#collection)
+
+#### Library Support
+ - [withReduxState](https://yeojz.github.io/react-form-addons#withReduxState) (Redux)
+
 ## Installation
 
 Install the library:
@@ -45,8 +60,8 @@ const Form = (props) => (
 );
 
 export default compose(
-	withState(),
-	withProps()
+  withState(),
+  withProps()
 )(Form);
 ```
 
@@ -96,12 +111,38 @@ can become
 
 ```js
 export default compose(
-  withReduxState(),
+  withLocalStorage(),
   withProps()
 )(Form);
 ```
 
-For now, this library does not provide the `redux` connector, but it is highly possible that it'll be sheduled for a future release. PRs are welcome! :)
+### Redux Support
+
+This library also provides a component for handling state in [redux](https://github.com/reactjs/redux). You'll need to install `react-redux` as well as `redux` for it to work. 
+
+*Note:* Redux components are not under default library export. As such, you'll have to import from a sub folder. i.e.
+
+```js
+import {withReduxState, formReducer} from 'react-form-addons/lib/redux';
+
+// Creating stores
+const reducers = combineReducers({
+  forms: formReducer
+});
+
+const store = createStore(reducers);
+
+// During form composition
+const Form = compose(
+  withReduxState(),
+  withProps()
+)(FormInputs);
+
+// Usage (note: prop "name" is required)
+<Form name='example' />
+```
+
+There is a [live example](https://yeojz.github.io/react-form-addons#withReduxState) in the documentation site.
 
 ## Prior Art
 

site/src/components/WithReduxStateExample.jsx

@@ -19,7 +19,7 @@ const getCode = () => (
     withProps()
   )(FormInputs);
 
-  // Usage (note: prop "name" is important)
+  // Usage (note: prop "name" is required)
   <Form name='example' />
   `
 );

site/src/store.js

@@ -1,5 +1,5 @@
 import {combineReducers, createStore} from 'redux';
-import {reducer as formReducer} from '../../lib/redux';
+import {formReducer} from '../../lib/redux';
 
 const reducers = combineReducers({
   forms: formReducer

src/redux/index.js

@@ -1,4 +1,4 @@
-export actions from './actions';
 export constants from './constants';
-export reducer from './reducer';
+export formActions from './formActions';
+export formReducer from './formReducer';
 export withReduxState from './withReduxState';

src/redux/withReduxState.js

@@ -2,7 +2,7 @@ import React, {PropTypes} from 'react';
 import {connect} from 'react-redux';
 import get from 'lodash/get';
 import noop from 'lodash/noop';
-import actions from './actions';
+import formActions from './formActions';
 
 const propTypes = {
   getReduxData: PropTypes.func,
@@ -62,8 +62,8 @@ const withReduxState = (reducerKey = 'forms') => (Component) => {
   });
 
   const mapDispatchToProps = {
-    onChange: actions.update,
-    onReset: actions.reset
+    onChange: formActions.update,
+    onReset: formActions.reset
   };
 
   return connect(mapStateToProps, mapDispatchToProps)(ComponentWithReduxState);

tests/redux/index.spec.js

@@ -0,0 +1,24 @@
+import {expect} from 'chai';
+import * as exposed from '../../src/redux/index';
+
+describe('redux/index', function () {
+  it('total number of exports', function () {
+    expect(Object.keys(exposed)).to.be.length(4)
+  });
+
+  it('exports constants', function () {
+    expect(exposed.constants).to.not.be.undefined;
+  });
+
+  it('exports formActions', function () {
+    expect(exposed.formActions).to.not.be.undefined;
+  });
+
+  it('exports formReducer', function () {
+    expect(exposed.formReducer).to.not.be.undefined;
+  });
+
+  it('exports withReduxState', function () {
+    expect(exposed.withReduxState).to.not.be.undefined;
+  });
+});