UNPKG

redux-leaves/README.md

Version:

1.3 kBMarkdownView Raw

1# redux-leaves
2
3Write once. Reduce anywhere.
4
5![Travis (.org)](https://img.shields.io/travis/richardcrng/redux-leaves.svg)
6[![Coverage Status](https://coveralls.io/repos/github/richardcrng/redux-leaves/badge.svg?branch=buttons)](https://coveralls.io/github/richardcrng/redux-leaves?branch=buttons)
7![David](https://img.shields.io/david/richardcrng/redux-leaves.svg)
8[![install size](https://packagephobia.now.sh/badge?p=redux-leaves)](https://packagephobia.now.sh/result?p=redux-leaves)
9[![npm version](https://badge.fury.io/js/redux-leaves.svg)](https://badge.fury.io/js/redux-leaves)
10[![Maintainability](https://api.codeclimate.com/v1/badges/371605931cb9f824e25c/maintainability)](https://codeclimate.com/github/richardcrng/redux-leaves/maintainability)
11
12## Documentation
13```bash
14npm install --save redux-leaves
15```
16
17[Main documentation website](https://redux-leaves.js.org)
18
19### Getting started
20- [Overview](intro/README.md)
21- [30 second demo](docs/examples/basic-example.md)
22
23### API reference
24- [Core: `reduxLeaves(initialState, reducers)`](docs/README.md)
25
26### Testing
27
28To run all tests locally:
29
30```bash
31git clone git@github.com:richardcrng/redux-leaves.git
32cd redux-leaves && npm run test a
33```
34
35Most tests are located alongside their relevant API documentation in the [docs](/docs) folder.
\No newline at end of file

1	`# redux-leaves`
2
3	`Write once. Reduce anywhere.`
4
5	`![Travis (.org)](https://img.shields.io/travis/richardcrng/redux-leaves.svg)`
6	`[![Coverage Status](https://coveralls.io/repos/github/richardcrng/redux-leaves/badge.svg?branch=buttons)](https://coveralls.io/github/richardcrng/redux-leaves?branch=buttons)`
7	`![David](https://img.shields.io/david/richardcrng/redux-leaves.svg)`
8	`[![install size](https://packagephobia.now.sh/badge?p=redux-leaves)](https://packagephobia.now.sh/result?p=redux-leaves)`
9	`[![npm version](https://badge.fury.io/js/redux-leaves.svg)](https://badge.fury.io/js/redux-leaves)`
10	`[![Maintainability](https://api.codeclimate.com/v1/badges/371605931cb9f824e25c/maintainability)](https://codeclimate.com/github/richardcrng/redux-leaves/maintainability)`
11
12	`## Documentation`
13	```bash
14	`npm install --save redux-leaves`
15	```
16
17	`[Main documentation website](https://redux-leaves.js.org)`
18
19	`### Getting started`
20	`- [Overview](intro/README.md)`
21	`- [30 second demo](docs/examples/basic-example.md)`
22
23	`### API reference`
24	- [Core: `reduxLeaves(initialState, reducers)`](docs/README.md)
25
26	`### Testing`
27
28	`To run all tests locally:`
29
30	```bash
31	`git clone git@github.com:richardcrng/redux-leaves.git`
32	`cd redux-leaves && npm run test a`
33	```
34
35	`Most tests are located alongside their relevant API documentation in the [docs](/docs) folder.`
\	No newline at end of file