Skip to content

Commit d3d9b73

Browse files
author
Scott Prue
committed
Fix reference to config object in docs.
1 parent 00b2a9d commit d3d9b73

File tree

4 files changed

+7
-59
lines changed

4 files changed

+7
-59
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ import { createStore, combineReducers, compose } from 'redux'
5656
import { ReactReduxFirebaseProvider, firebaseReducer } from 'react-redux-firebase'
5757
// import { createFirestoreInstance, firestoreReducer } from 'redux-firestore' // <- needed if using firestore
5858

59-
const firebaseConfig = {}
59+
const fbConfig = {}
6060

6161
// react-redux-firebase config
6262
const rrfConfig = {
@@ -65,7 +65,7 @@ const rrfConfig = {
6565
}
6666

6767
// Initialize firebase instance
68-
firebase.initializeApp(firebaseConfig)
68+
firebase.initializeApp(fbConfig)
6969

7070
// Initialize other services on firebase instance
7171
// firebase.firestore() // <- needed if using firestore

docs/getting_started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ import { createStore, combineReducers, compose } from 'redux'
3939
import { ReactReduxFirebaseProvider, firebaseReducer } from 'react-redux-firebase'
4040
// import { createFirestoreInstance, firestoreReducer } from 'redux-firestore' // <- needed if using firestore
4141

42-
const firebaseConfig = {}
42+
const fbConfig = {}
4343

4444
// react-redux-firebase config
4545
const rrfConfig = {
@@ -48,7 +48,7 @@ const rrfConfig = {
4848
}
4949

5050
// Initialize firebase instance
51-
firebase.initializeApp(firebaseConfig)
51+
firebase.initializeApp(fbConfig)
5252

5353
// Initialize other services on firebase instance
5454
// firebase.firestore() // <- needed if using firestore

docs/roadmap.md

Lines changed: 1 addition & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,3 @@
11
# Roadmap
22

3-
## Current Version (`v2.*.*`)
4-
5-
For updates on issues in the current version, visit the [projects page on Github](https://github.com/prescottprue/react-redux-firebase/projects). Issues are assigned to projects as they are opened.
6-
7-
## Next Major Version (`3.*.*`)
8-
9-
### Breaking Changes
10-
* State no longer second argument of functions passed to `firebaseConnect` and `firestoreConnect` HOCs - causes issues including not re-rendering since props are not changing
11-
12-
### Features
13-
* `withPropsFromFirebase` HOC for data from Firebase straight to props (skipping redux)
14-
* Multi-level population
15-
* Option to re-render HOCs (`firebaseConnect` and `firestoreConnect`) based on auth state change - [#367](https://github.com/prescottprue/react-redux-firebase/issues/367)
16-
* Possibility of delayed initialization - [#70](https://github.com/prescottprue/react-redux-firebase/issues/70) (more research needed)
17-
* Higher Order Components (or HOC factory) that force data to exist before rendering component (maybe `AuthRequired` or `DataLoaded`)
18-
19-
## Future Versions
20-
* Population rules suggestion/generation
21-
* Optional Built in Role Management
22-
23-
## Previous Versions (`v1.*.*`)
24-
25-
Note, updates of `v1.*.*` versions have been de-prioritized due to the high adoption of `v2.0.0` syntax.
26-
27-
## `v1.6.0`
28-
29-
#### Features
30-
* Renaming a file on upload (currently does not work due to HTML 5 File element being read only)
31-
32-
#### Enhancements/Fixes
33-
* Fix `TypeError: Converting circular structure to JSON` (through update of firebase version) - [#230](https://github.com/prescottprue/react-redux-firebase/issues/230)
34-
35-
## `v1.7.0 - v1.*.*`
36-
37-
**Note:** Subject to change
38-
39-
#### Breaking Changes
40-
*None Yet Planned*
41-
42-
#### Features
43-
* `preserveOnLogout` config option to preserve certain data on logout (already supported in v2.0.0)
44-
* Population of ordered data (already supported in v2.0.0) - [#239](https://github.com/prescottprue/react-redux-firebase/issues/239)
45-
* `childAlias` to store populate result on another parameter - [#126](https://github.com/prescottprue/react-redux-firebase/issues/126)
46-
* `waitForPopulate` option to allow data to be returned before populated data as in becomes available. As of `v1.4.0-rc.2`, populate only sets `isLoaded` to true after all children are loaded, `waitForPopulate` would make this optional - [#121](https://github.com/prescottprue/react-redux-firebase/issues/121)
47-
* Config option for populated items updating when changed - [#69](https://github.com/prescottprue/react-redux-firebase/issues/69)
48-
* Improved support for batching of UI updates as the result of a database "array" loading - [#212](https://github.com/prescottprue/react-redux-firebase/issues/212)
49-
* Expose whole Firebase instance (warning: Using Firebase instance methods will not dispatch actions or update redux state)
50-
* Nested populates [#85](https://github.com/prescottprue/react-redux-firebase/issues/85))
51-
* Support for universal environments (i.e. no `next` function) - [#199](https://github.com/prescottprue/react-redux-firebase/issues/199)
52-
* Option to clear redux data on `firebaseConnect` unmount - [#55](https://github.com/prescottprue/react-redux-firebase/issues/85)
53-
54-
#### Enhancements/Fixes
55-
* Fix `TypeError: Converting circular structure to JSON` (through update of firebase version) - [#230](https://github.com/prescottprue/react-redux-firebase/issues/230)
3+
Please visit [the v3.0.0 Roadmap wiki doc](https://github.com/prescottprue/react-redux-firebase/wiki/v3.0.0-Roadmap)

docs/v3-migration-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ const fbConfig = {} // object containing Firebase config
104104
const rrfConfig = { userProfile: 'users' } // react-redux-firebase config
105105

106106
// Initialize firebase instance
107-
firebase.initializeApp(firebaseConfig)
107+
firebase.initializeApp(fbConfig)
108108

109109
export default () => {
110110
return createStore(
@@ -178,7 +178,7 @@ const fbConfig = {} // object containing Firebase config
178178
const rrfConfig = { userProfile: 'users' } // react-redux-firebase config
179179

180180
// Initialize firebase instance
181-
firebase.initializeApp(firebaseConfig)
181+
firebase.initializeApp(fbConfig)
182182

183183
const store = createReduxStore()
184184

0 commit comments

Comments
 (0)