Skip to content

Commit 7e7bbd7

Browse files
committed
Updates docs
1 parent 43bb98e commit 7e7bbd7

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ store.getState();
5050
- [Deriving state](#deriving-state)
5151
- [Accessing Derived State](#accessing-derived-state)
5252
- [Final notes](#final-notes)
53-
- [Usage with React](#usage-with-react)
53+
- [Integration with Frameworks](#integration-with-frameworks)
54+
- [Usage with React](#usage-with-react)
5455
- [API](#api)
5556
- [createStore(model, config)](#createstoremodel-config)
5657
- [action](#action)
@@ -62,7 +63,7 @@ store.getState();
6263

6364
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.
6465

65-
Easy Peasy outputs a Redux store, which means you can easily use it with frameworks like React. Read the integration docs below.
66+
Easy Peasy outputs a Redux store, which means you can integrate with frameworks like React. Read the [integration docs](#integration-with-frameworks) below.
6667

6768
## Installation
6869

@@ -226,17 +227,23 @@ This was just a brief overview of how to create and interact with an Easy Peasy
226227
227228
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. 👍
228229
229-
## Usage with React
230+
## Integration with Frameworks
231+
232+
Below showcases how simple it is to integrate Easy Peasy with existing frameworks.
233+
234+
> Note: React is only shown at the moment, but hopefully will receive some pull requests to show off some others. 😘
235+
236+
### Usage with React
230237
231238
To use `easy-peasy` with React simply leverage the official [`react-redux`](https://github.com/reduxjs/react-redux) package.
232239
233-
### First, install the `react-redux` package
240+
#### First, install the `react-redux` package
234241
235242
```bash
236243
npm install react-redux
237244
```
238245
239-
### Then wrap your app with the `Provider`
246+
#### Then wrap your app with the `Provider`
240247
241248
```javascript
242249
import React from 'react';

0 commit comments

Comments
 (0)