Skip to content

Commit 5102e23

Browse files
committed
Improved Motivation in docs and a few more things.
1 parent 4c93c1f commit 5102e23

File tree

3 files changed

+16
-10
lines changed

3 files changed

+16
-10
lines changed

docs/Introduction.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,25 @@
22

33
## Motivation
44

5-
A way of creating a modularized and universal system which has its state under control, using Redux as its core.
6-
7-
Reduce boilerplate when using a "[Redux](https://github.com/reactjs/redux/) stack".
5+
As web applications evolve, we see more people jumping into the mix bringing their problem to the table for web technologies to solve.
6+
7+
Today's web developers have to deal with a lot more complexity than before when the web was a secondary media and mobile internet access and browsers were too limited.
8+
9+
JavaScript development and web development in general have also changed a lot in the last years, we now have everything we once dreamed about: JavaScript language is finally improving fast, we got a lot of new things with ES6, HTML5 and CSS3, and this time we don't need to wait for browser vendors to implement the latest language improvements for us to start using them. Also running JavaScript on the backend is now a reality.
10+
11+
That being said, it's time for us to bring back sanity, simplicity and control to our application development stack. Thinking in ways of how we could achieve that, we created **Redux Boot**.
12+
13+
Redux Boot is a way for creating modularized and universal systems on top of [Redux](http://redux.js.org/), which have their state fully under control. Redux Boot also reduce boilerplate code compared to standard Redux's stacks.
814

915
## Principles
1016

1117
Based on the Functional Programming principles / paradigms.
1218

1319
1. Changes of the state are explicit.
1420
2. Eliminate redundant code.
15-
3. Stateless functions (no *this* keyword).
21+
3. Stateless functions (no `this` keyword).
1622
4. Side-effects, are reactions from dispatched actions.
17-
5. The value of variables are immutable. Create a new value instead of changing.
18-
6. Modules and functions should have just one goal.
19-
7. Keep your logic stateless.
23+
5. The value of variables are immutable. Create a new value instead of changing it.
24+
6. Modules and functions should have just one purpose.
25+
7. Keep logic stateless.
2026

docs/Modules.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Modules
22

3-
A module implements a [reducer](Reducers.md) and/or a [middleware](Middlewares.md). They should deal with a standard [Redux store](http://redux.js.org/docs/api/Store.html) and assume all actions are [FSA](https://github.com/acdlite/flux-standard-action) compliant. Modules can also implement a [store enhancer](http://redux.js.org/docs/Glossary.html#store-enhancer).
3+
A module implements a [reducer](Reducers.md) and/or a [middleware](Middlewares.md). They should deal with a standard [Redux's store](http://redux.js.org/docs/api/Store.html) and assume all actions are [FSA](https://github.com/acdlite/flux-standard-action) compliant. Modules can also implement a [store enhancer](http://redux.js.org/docs/Glossary.html#store-enhancer).
44

55
The basic module structure is the following:
66

@@ -22,7 +22,7 @@ const module = {
2222
}
2323
```
2424

25-
For convenience and better code readability, the reducer can also be an object. If so, it's meant to be a [redux-actions](https://github.com/acdlite/redux-actions) action handler object. Redux Boot also provides middleware handlers which are like redux-actions action handlers but for middlewares:
25+
For convenience and better code readability, the reducer can also be an object. If so, it's meant to be a [redux-actions](https://github.com/acdlite/redux-actions)' action handler object. Redux Boot also provides middleware handlers which are like redux-actions action handlers but for middlewares:
2626

2727
```js
2828
import boot, {BOOT} from 'redux-boot'

docs/SideEffects.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Side Effects
22

3-
## What ?
3+
## What?
44

55
**From Wikipedia:**
66
> In computer science, a function or expression is said to have a side effect if it **modifies some state** or has an observable interaction with **calling functions or the outside world.**

0 commit comments

Comments
 (0)