diff --git a/README.md b/README.md index 80d483494..1a77d1a60 100644 --- a/README.md +++ b/README.md @@ -59,18 +59,24 @@ store.getState(); - [select(selector)](#select) - [Prior Art](#prior-art) +--- + ## Introduction 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. Easy Peasy outputs a Redux store, which means you can integrate with frameworks like React. Read the [integration docs](#integration-with-frameworks) below. +--- + ## Installation ```bash npm install easy-peasy ``` +--- + ## Examples ### React Todo List @@ -79,6 +85,8 @@ A simple/naive implementation of a todo list. https://codesandbox.io/s/7k62z0qyoq +--- + ## Tutorial ### Setting up your store @@ -227,6 +235,8 @@ This was just a brief overview of how to create and interact with an Easy Peasy 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. 👍 +--- + ## Integration with Frameworks Below showcases how simple it is to integrate Easy Peasy with existing frameworks. @@ -289,6 +299,8 @@ export default connect( )(EditTodo) ``` +--- + ## API Below is an overview of the API exposed by Easy Peasy. @@ -477,6 +489,8 @@ const store = createStore({ store.getState().shoppingBasket.totalPrice ``` +--- + ## Prior art 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.