Create basic documentation

choko-org / redux-boot

Modular Redux bootstrap with asynchronous side-effects.

MIT License

126 stars 7 forks source link

Create basic documentation #15

Closed sebas5384 closed 8 years ago

sebas5384 commented 8 years ago

[x] Example using handlers at README.md

[x] Introduction
[x] -- Motivation
[x] -- Principles
[x] Basics
[x] -- Modules
[x] -- Actions
[x] -- Reducers
[x] ---- pure reducer
[x] ---- Action handlers
[x] -- Middlewares
[x] ---- pure middleware
[x] ---- Middleware handlers
[x] -- Side-effects
[x] ---- Sync
[x] ---- Async

sebas5384 commented 8 years ago

Middlewares:

Simple:

const API_REQUEST = 'mymodule/api/REQUEST'
const mymodule = {
  middleware(store) {
    return next => action => {

      if (action.type == API_REQUEST) {
        console.log(action.payload.body, 'Api request');
      }

      return next(action)
    }
  }
}

sebas5384 commented 8 years ago

Side-effect after and after an action is done https://github.com/choko-org/redux-boot/commit/8298643e8dc2596702b8597a8d17ee7b287a71cd.

sebas5384 commented 8 years ago

@recidive and @jardix22 what do you say guys? can we close this one?

https://choko.gitbooks.io/redux-boot

sebas5384 commented 8 years ago

@recidive I think is just missing the Actions topic.