Skip to content

Commit db6a5ad

Browse files
committed
Urls in README don't have .html endings.
1 parent 03fef14 commit db6a5ad

File tree

3 files changed

+54
-20
lines changed

3 files changed

+54
-20
lines changed

README.md

+19-11
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,10 @@
1515

1616
View deployed version of [Material Example](https://github.com/prescottprue/react-redux-firebase/tree/master/examples/complete/material) [here](https://redux-firebasev3.firebaseapp.com/)
1717

18-
1918
## Features
2019
- Integrated into redux
2120
- Support for updating and nested props
22-
- [Population capability](http://react-redux-firebase.com/docs/populate.html) (similar to mongoose's `populate` or SQL's `JOIN`)
21+
- [Population capability](http://react-redux-firebase.com/docs/populate) (similar to mongoose's `populate` or SQL's `JOIN`)
2322
- Out of the box support for authentication (with auto load user profile)
2423
- Firebase Storage Support
2524
- Support small data ( using `value` ) or large datasets ( using `child_added`, `child_removed`, `child_changed` )
@@ -120,7 +119,7 @@ const { isLoaded, isEmpty, dataToJS } = helpers
120119
todos: dataToJS(firebase, '/todos'),
121120
})
122121
)
123-
class Todos extends Component {
122+
export default class Todos extends Component {
124123
static propTypes = {
125124
todos: PropTypes.object,
126125
firebase: PropTypes.object
@@ -161,7 +160,6 @@ class Todos extends Component {
161160
)
162161
}
163162
}
164-
export default Todos
165163
```
166164

167165
Alternatively, if you choose not to use decorators:
@@ -179,9 +177,15 @@ export default connect(
179177

180178
```
181179

182-
## [API](http://react-redux-firebase.com)
180+
## [Documentation](http://react-redux-firebase.com)
183181
See [react-redux-firebase.com](http://react-redux-firebase.com)
184182

183+
* [Getting Started](http://react-redux-firebase.com/docs/getting_started)
184+
* [Auth](http://react-redux-firebase.com/docs/auth)
185+
* [Queries](http://react-redux-firebase.com/docs/queries)
186+
* [Populate](http://react-redux-firebase.com/docs/populate)
187+
* [API Reference](http://react-redux-firebase.com/docs/api)
188+
185189
## [Examples](examples)
186190

187191
Examples folder is broken into two categories [complete](https://github.com/prescottprue/react-redux-firebase/tree/master/examples/complete) and [snippets](https://github.com/prescottprue/react-redux-firebase/tree/master/examples/snippets). Complete contains full applications that can be run as is, where as snippets is small amounts of code to show functionality (dev tools and deps not included).
@@ -202,6 +206,10 @@ A simple example that was created using [create-react-app](https://github.com/fa
202206

203207
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/).
204208

209+
## Discussion
210+
211+
Join the [redux-firebase gitter](https://gitter.im/redux-firebase/Lobby).
212+
205213
## Using with `redux-thunk`
206214
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:
207215

@@ -276,17 +284,17 @@ const somethingEpic = (action$, store, getFirebase) =>
276284
1. How is this different than [`redux-react-firebase`](https://github.com/tiberiuc/redux-react-firebase)?
277285

278286
This library was actually originally forked from redux-react-firebase, but adds extended functionality such as:
279-
* [populate functionality](http://react-redux-firebase.com/docs/populate.html) (similar to mongoDB or SQL JOIN)
280-
* [`profileDecorator`](http://react-redux-firebase.com/docs/config.html) - change format of profile stored on Firebase
281-
* [`getFirebase`](http://react-redux-firebase.com/docs/thunks.html) - access to firebase instance that fires actions when methods are called
282-
* [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`
283-
* [access to firebase's `storage`](http://react-redux-firebase.com/docs/storage.html) method`
287+
* [populate functionality](http://react-redux-firebase.com/docs/populate) (similar to mongoDB or SQL JOIN)
288+
* [`profileDecorator`](http://react-redux-firebase.com/docs/config) - change format of profile stored on Firebase
289+
* [`getFirebase`](http://react-redux-firebase.com/docs/thunks) - access to firebase instance that fires actions when methods are called
290+
* [integrations](http://react-redux-firebase.com/docs/thunks) for [`redux-thunk`](https://github.com/gaearon/redux-thunk) and [`redux-observable`](https://redux-observable.js.org) - using `getFirebase`
291+
* [access to firebase's `storage`](http://react-redux-firebase.com/docs/storage) method`
284292
* `uniqueSet` method helper for only setting if location doesn't already exist
285293
* Object or String notation for paths (`[{ path: '/todos' }]` equivalent to `['/todos']`)
286294
* Action Types and other Constants are exposed for external usage (such as with `redux-observable`)
287295

288296
#### Well why not combine?
289-
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.
297+
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.
290298

291299
**Bottom line:** The author of redux-react-firebase was absent when functionality was needed by me and others, so this library was created.
292300

docs/README.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
1-
# Table of Contents
1+
# Summary
22

33
* [Read Me](/README.md)
44
* [Getting Started](/docs/getting_started.md)
55
* [Auth](/docs/auth.md)
6-
* [Queries](docs/queries.md)
7-
* [Populate](docs/populate.md)
8-
* [Storage](docs/storage.md)
9-
* [Recipes](docs/recipes.md)
10-
* [Actions](docs/actions.md)
11-
* [Thunks](docs/thunks.md)
6+
* [Queries](/docs/queries.md)
7+
* [Populate](/docs/populate.md)
8+
* [Storage](/docs/storage.md)
9+
* [Recipes](/docs/recipes/README.md)
10+
* [Upload](/docs/recipes/upload.md)
11+
* [Actions](/docs/recipes/actions.md)
12+
* [Thunks](/docs/recipes/thunks.md)
1213
* [API Reference](/docs/api/README.md)
1314
* [constants](/docs/api/constants.md)
1415
* [firebaseConnect](/docs/api/connect.md)
1516
* [firebaseStateReducer](/docs/api/reducer.md)
1617
* [reactReduxFirebase](/docs/api/compose.md)
1718
* [helpers](/docs/api/helpers.md)
18-
* [Roadmap](docs/roadmap.md)
19-
* [Contributing](docs/contributing.md)
19+
* [Roadmap](/docs/roadmap.md)
20+
* [Contributing](/docs/contributing.md)

docs/api/README.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# API Reference
2+
3+
Just like [redux](http://redux.js.org/docs/api/index.html), the react-redux-firebase API surface is small.
4+
5+
## Top-Level Exports
6+
* [firebaseConnect](/docs/api/connect.md)
7+
* [firebaseStateReducer](/docs/api/reducer.md)
8+
* [reactReduxFirebase](/docs/api/compose.md)
9+
* [constants](/docs/api/constants.md)
10+
* [actionTypes](/docs/api/constants.md)
11+
* [helpers](/docs/api/helpers.md)
12+
13+
## Importing
14+
15+
Every function described above is a top-level export. You can import any of them like this:
16+
17+
### ES6
18+
```js
19+
import { firebaseConnect } from 'react-redux-firebase'
20+
```
21+
22+
### ES5 (CommonJS)
23+
```js
24+
var firebaseConnect = require('react-redux-firebase').firebaseConnect
25+
```

0 commit comments

Comments
 (0)