Skip to content

Commit 5fca2f0

Browse files
committed
Updates docs
1 parent 7e7bbd7 commit 5fca2f0

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,18 +59,24 @@ store.getState();
5959
- [select(selector)](#select)
6060
- [Prior Art](#prior-art)
6161

62+
---
63+
6264
## Introduction
6365

6466
Easy Peasy gives you the power of Redux and its tooling whilst avoiding the boilerplate. It allows you to create a full Redux store by defining a simple model (object) to describe your state and it's actions.
6567

6668
Easy Peasy outputs a Redux store, which means you can integrate with frameworks like React. Read the [integration docs](#integration-with-frameworks) below.
6769

70+
---
71+
6872
## Installation
6973

7074
```bash
7175
npm install easy-peasy
7276
```
7377

78+
---
79+
7480
## Examples
7581

7682
### React Todo List
@@ -79,6 +85,8 @@ A simple/naive implementation of a todo list.
7985

8086
https://codesandbox.io/s/7k62z0qyoq
8187

88+
---
89+
8290
## Tutorial
8391

8492
### Setting up your store
@@ -227,6 +235,8 @@ This was just a brief overview of how to create and interact with an Easy Peasy
227235
228236
Oh! And don't forget to install the [Redux Dev Tools Extension](https://github.com/zalmoxisus/redux-devtools-extension) to help visualise actions and state updates. 👍
229237
238+
---
239+
230240
## Integration with Frameworks
231241
232242
Below showcases how simple it is to integrate Easy Peasy with existing frameworks.
@@ -289,6 +299,8 @@ export default connect(
289299
)(EditTodo)
290300
```
291301
302+
---
303+
292304
## API
293305
294306
Below is an overview of the API exposed by Easy Peasy.
@@ -477,6 +489,8 @@ const store = createStore({
477489
store.getState().shoppingBasket.totalPrice
478490
```
479491
492+
---
493+
480494
## Prior art
481495
482496
This library was massively inspired by the following awesome projects. I tried to take the best bits I liked about them all and create this package. Huge love to all contributors involved in the below.

0 commit comments

Comments
 (0)