Docs added for constants. Examples added for most main functions.

Author: prescottprue

README.md

@@ -19,7 +19,7 @@ View deployed version of [Material Example](https://github.com/prescottprue/reac
 ## Features
 - Integrated into redux
 - Support for updating and nested props
-- [Population capability](https://prescottprue.gitbooks.io/react-redux-firebase/content/populate.html) (similar to mongoose's `populate` or SQL's `JOIN`)
+- [Population capability](http://react-redux-firebase.com/docs/populate.html) (similar to mongoose's `populate` or SQL's `JOIN`)
 - Out of the box support for authentication (with auto load user profile)
 - Firebase Storage Support
 - Support small data ( using `value` ) or large datasets ( using `child_added`, `child_removed`, `child_changed` )
@@ -179,8 +179,8 @@ export default connect(
 
 ```
 
-## [API](https://prescottprue.gitbooks.io/react-redux-firebase/content/)
-See [API Docs](https://prescottprue.gitbooks.io/react-redux-firebase/content/)
+## [API](http://react-redux-firebase.com)
+See [react-redux-firebase.com](http://react-redux-firebase.com)
 
 ## [Examples](examples)
 
@@ -200,7 +200,7 @@ A simple example that was created using [create-react-app](https://github.com/fa
 
 #### [Material App Example](examples/complete/material)
 
-An example that user Material UI built on top of the output of [create-react-app](https://github.com/facebookincubator/create-react-app)'s eject command.  Shows a list of todo items and allows you to add to them. This is what is deployed to [react-redux-firebase.firebaseapp.com](https://react-redux-firebase.firebaseapp.com/).
+An example that user Material UI built on top of the output of [create-react-app](https://github.com/facebookincubator/create-react-app)'s eject command.  Shows a list of todo items and allows you to add to them. This is what is deployed to [redux-firebasev3.firebaseapp.com](https://redux-firebasev3.firebaseapp.com/).
 
 ## Using with `redux-thunk`
 If you are using `redux-thunk`, make sure to set up your thunk middleware using it's redux-thunk's `withExtraArgument` method so that firebase is available within your actions. Here is an example `createStore` function that adds `getFirebase` as third argument along with a thunk that uses it:
@@ -214,15 +214,18 @@ import { reactReduxFirebase, getFirebase } from 'react-redux-firebase';
 import makeRootReducer from './reducers';
 
 const fbConfig = {} // your firebase config
-
+const config = {
+  userProfile: 'users',
+  enableLogging: false
+}
 const store = createStore(
   makeRootReducer(),
   initialState,
   compose(
     applyMiddleware([
       thunk.withExtraArgument(getFirebase) // Pass getFirebase function as extra argument
     ]),
-    reactReduxFirebase(fbConfig, { userProfile: 'users', enableLogging: false })
+    reactReduxFirebase(fbConfig, )
   )
 );
 
@@ -273,17 +276,17 @@ const somethingEpic = (action$, store, getFirebase) =>
 1. How is this different than [`redux-react-firebase`](https://github.com/tiberiuc/redux-react-firebase)?
 
   This library was actually originally forked from redux-react-firebase, but adds extended functionality such as:
-  * [populate functionality](https://prescottprue.gitbooks.io/react-redux-firebase/content/populate.html) (similar to mongoDB or SQL JOIN)
-  * [`profileDecorator`](https://prescottprue.gitbooks.io/react-redux-firebase/content/config.html) - change format of profile stored on Firebase
-  * [`getFirebase`](https://prescottprue.gitbooks.io/react-redux-firebase/content/thunks.html) - access to firebase instance that fires actions when methods are called
-  * [integrations](https://prescottprue.gitbooks.io/react-redux-firebase/content/thunks.html) for [`redux-thunk`](https://github.com/gaearon/redux-thunk) and [`redux-observable`](https://redux-observable.js.org) - using `getFirebase`
-  * [access to firebase's `storage`](https://prescottprue.gitbooks.io/react-redux-firebase/content/storage.html) method`
+  * [populate functionality](http://react-redux-firebase.com/docs/populate.html) (similar to mongoDB or SQL JOIN)
+  * [`profileDecorator`](http://react-redux-firebase.com/docs/config.html) - change format of profile stored on Firebase
+  * [`getFirebase`](http://react-redux-firebase.com/docs/thunks.html) - access to firebase instance that fires actions when methods are called
+  * [integrations](http://react-redux-firebase.com/docs/thunks.html) for [`redux-thunk`](https://github.com/gaearon/redux-thunk) and [`redux-observable`](https://redux-observable.js.org) - using `getFirebase`
+  * [access to firebase's `storage`](http://react-redux-firebase.com/docs/storage.html) method`
   * `uniqueSet` method helper for only setting if location doesn't already exist
   * Object or String notation for paths (`[{ path: '/todos' }]` equivalent to `['/todos']`)
-  * Action Types and other Constants are exposed for external usage (such as `redux-observable`)
+  * Action Types and other Constants are exposed for external usage (such as with `redux-observable`)
 
   #### Well why not combine?
-  I have been talking to the author of [redux-react-firebase]() about combining, but we are not sure that the users of both want that at this point. Join us on [the redux-firebase gitter](https://gitter.im/redux-firebase/Lobby) if you haven't already since a ton of this type of discussion goes on there.
+  I have been talking to the author of [redux-react-firebase](https://github.com/tiberiuc/redux-react-firebase) about combining, but we are not sure that the users of both want that at this point. Join us on [the redux-firebase gitter](https://gitter.im/redux-firebase/Lobby) if you haven't already since a ton of this type of discussion goes on there.
 
   **Bottom line:** The author of redux-react-firebase was absent when functionality was needed by me and others, so this library was created.
 

SUMMARY.md

@@ -1,20 +1,19 @@
 # Summary
 
-* [Read Me](docs/README.md)
-* [Getting Started](docs/getting_started.md)
-* [Config](docs/config.md)
-* [Auth](docs/auth.md)
-* [Helpers](docs/helpers.md)
+* [Read Me](/README.md)
+* [Getting Started](/docs/getting_started.md)
+* [Auth](/docs/auth.md)
 * [Queries](docs/queries.md)
 * [Populate](docs/populate.md)
 * [Storage](docs/storage.md)
 * [Recipes](docs/recipes.md)
    * [Actions](docs/actions.md)
    * [Thunks](docs/thunks.md)
-* [Roadmap](docs/roadmap.md)
-* [Contributing](docs/contributing.md)
 * [API Reference](/docs/api/README.md)
+  * [constants](/docs/api/constants.md)
   * [firebaseConnect](/docs/api/connect.md)
   * [firebaseStateReducer](/docs/api/reducer.md)
   * [reactReduxFirebase](/docs/api/compose.md)
   * [helpers](/docs/api/helpers.md)
+* [Roadmap](docs/roadmap.md)
+* [Contributing](docs/contributing.md)

bin/api-docs-generate.js

@@ -15,6 +15,10 @@ const files = [
   {
     src: 'reducer.js',
     dest: 'reducer.md'
+  },
+  {
+    src: 'constants.js',
+    dest: 'constants.md'
   }
 ]
 const pathToDocumentationJs = 'node_modules/documentation/bin/documentation.js'

docs/README.md

@@ -1,52 +1,19 @@
-# React Redux Firebase
-
-React Higher Order component library for Firebase with Redux integration
-
-## Demo
-
-View deployed version of Material Example [here](https://redux-firebasev3.firebaseapp.com/)
-
-
-## Features
-- Higher Order Component (HOC) for react
-- Integrated into redux
-- [Population](/populate.md) capability (similar to mongo `populate` or SQL `JOIN`)
-- Support small data ( using `value` ) or large datasets ( using `child_added`, `child_removed`, `child_changed` )
-- [queries support](/queries.md) ( `orderByChild`, `orderByKey`, `orderByValue`, `orderByPriority`, `limitToLast`, `limitToFirst`, `startAt`, `endAt`, `equalTo` right now )
-- Automatic binding/unbinding
-- Declarative decorator syntax for React components
-- Firebase v3+ support
-- Support for updating and nested props
-- Out of the box support for authentication (with auto load user profile)
-- Lots of helper functions
-
-
-## [Examples](examples)
-
-#### [Simple Example](examples/simple)
-
-A simple example that was created using [create-react-app](https://github.com/facebookincubator/create-react-app)'s. Shows a list of todo items and allows you to add to them.
-
-#### [Decorators Example](examples/decorators)
-
-The simple example implemented using decorators built from the output of [create-react-app](https://github.com/facebookincubator/create-react-app)'s eject command. Shows a list of todo items and allows you to add to them.
-
-#### [Material Example](examples/material)
-
-An example that user Material UI built on top of the output of [create-react-app](https://github.com/facebookincubator/create-react-app)'s eject command.  Shows a list of todo items and allows you to add to them. This is what is deployed to [redux-firebasev3.firebaseapp.com](https://redux-firebasev3.firebaseapp.com/).
-
-
-## Generator
-
-[generator-react-firebase](https://github.com/prescottprue/generator-react-firebase) uses react-redux-firebase when opting to include redux
-
-## Contributors
-- [Prescott Prue](https://github.com/prescottprue)
-- [Tiberiu Craciun](https://github.com/tiberiuc)
-- [Bojhan](https://github.com/Bojhan)
-- [Rahav Lussto](https://github.com/RahavLussato)
-- [Justin Handley](https://github.com/justinhandley)
-
-## Thanks
-
-Special thanks to [Tiberiu Craciun](https://github.com/tiberiuc) for creating [redux-react-firebase](https://github.com/tiberiuc/redux-react-firebase), which this project is heavily based on.
+# Table of Contents
+
+* [Read Me](/README.md)
+* [Getting Started](/docs/getting_started.md)
+* [Auth](/docs/auth.md)
+* [Queries](docs/queries.md)
+* [Populate](docs/populate.md)
+* [Storage](docs/storage.md)
+* [Recipes](docs/recipes.md)
+   * [Actions](docs/actions.md)
+   * [Thunks](docs/thunks.md)
+* [API Reference](/docs/api/README.md)
+  * [constants](/docs/api/constants.md)
+  * [firebaseConnect](/docs/api/connect.md)
+  * [firebaseStateReducer](/docs/api/reducer.md)
+  * [reactReduxFirebase](/docs/api/compose.md)
+  * [helpers](/docs/api/helpers.md)
+* [Roadmap](docs/roadmap.md)
+* [Contributing](docs/contributing.md)

docs/SUMMARY.md

@@ -2,11 +2,50 @@
 
 # reactReduxFirebase
 
-Configuration call to be placed in compose call
+Middleware that handles configuration (placed in redux's `compose` call)
 
 **Parameters**
 
 -   `fbConfig` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Object containing Firebase config including databaseURL
--   `config` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Object containing other config such as userProfile
+    -   `fbConfig.apiKey` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firebase apiKey
+    -   `fbConfig.authDomain` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firebase auth domain
+    -   `fbConfig.databaseURL` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firebase database url
+    -   `fbConfig.storageBucket` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firebase storage bucket
+-   `config` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Containing react-redux-firebase specific config such as userProfile
+    -   `config.userProfile` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Location on firebase to store user profiles
+    -   `config.enableLogging` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Location on firebase to store user profiles. default: `false`
+    -   `config.profileDecorator` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** Location on firebase to store user profiles. default: `false`
+    -   `config.updateProfileOnLogin` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Whether or not to update profile when logging in. default: `false`
+    -   `config.profileParamsToPopulate` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Whether or not to update profile when logging in. default: `false`
 
-Returns **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** 
+**Examples**
+
+_Data_
+
+```javascript
+import { createStore, compose } from 'redux'
+import { reactReduxFirebase } from 'react-redux-firebase'
+
+// Firebase config
+const fbConfig = {
+ apiKey: '<your-api-key>',
+ authDomain: '<your-auth-domain>',
+ databaseURL: '<your-database-url>',
+ storageBucket: '<your-storage-bucket>'
+}
+
+// React Redux Firebase Config
+const config = {
+  userProfile: 'users'
+}
+
+// Add react-redux-firebase to compose
+const createStoreWithFirebase = compose(
+ reactReduxFirebase(fbConfig, config),
+)(createStore)
+
+// Use Function later to create store
+const store = createStoreWithFirebase(rootReducer, initialState)
+```
+
+Returns **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** That accepts a component a returns a wrapped version of component

docs/api/compose.md

@@ -9,4 +9,48 @@ to provided firebase paths using React's Lifecycle hooks.
 
 -   `watchArray` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** Array of objects or strings for paths to sync from Firebase
 
-Returns **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** 
+**Examples**
+
+_Basic_
+
+```javascript
+// this.props.firebase set on App component as firebase object with helpers
+import { firebaseConnect } from 'react-redux-firebase'
+export default firebaseConnect()(App)
+```
+
+_Paths_
+
+```javascript
+import { connect } from 'react-redux'
+import { firebaseConnect, helpers } from 'react-redux-firebase'
+const { pathToJS } = helpers
+
+const fbWrapped = firebaseConnect()(App)
+
+// pass todos list from redux as this.props.todosList
+export default connect(({ firebase }) => ({
+  profile: pathToJS(firebase, 'profile'),
+  auth: pathToJS(firebase, 'auth')
+}))(fbWrapped)
+```
+
+_Data_
+
+```javascript
+import { connect } from 'react-redux'
+import { firebaseConnect, helpers } from 'react-redux-firebase'
+const { dataToJS } = helpers
+
+// sync /todos from firebase into redux
+const fbWrapped = firebaseConnect([
+  'todos'
+])(App)
+
+// pass todos list from redux as this.props.todosList
+export default connect(({ firebase }) => ({
+  todosList: dataToJS(firebase, 'todos')
+}))(fbWrapped)
+```
+
+Returns **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** that accepts a component to wrap and returns the wrapped component

docs/api/connect.md

@@ -0,0 +1,50 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+# actionsPrefix
+
+Prefix for all actions within library
+
+**Examples**
+
+```javascript
+import { constants } from 'react-redux-firebase'
+constants.actionsPrefix === '@@reactReduxFirebase' // true
+```
+
+# defaultJWTKeys
+
+Default keys returned within JSON Web Token recieved when authenticating
+
+**Examples**
+
+```javascript
+import { constants } from 'react-redux-firebase'
+constants.defaultJWTKeys // list of default JWT keys from Firebase
+```
+
+# actionTypes
+
+Object containing all action types
+
+**Examples**
+
+```javascript
+import { actionTypes } from 'react-redux-firebase'
+actionTypes.SET === '@@reactReduxFirebase/SET' // true
+```
+
+```javascript
+import { constants } from 'react-redux-firebase'
+constants.actionTypes.SET === '@@reactReduxFirebase/SET' // true
+```
+
+# supportedAuthProviders
+
+List of all external auth providers that are supported (firebase's email/anonymous included by default)
+
+**Examples**
+
+```javascript
+import { constants } from 'react-redux-firebase'
+constants.supportedAuthProviders // list of supportedAuthProviders
+```