# Getting Started

## Installation

Redux Preboiled is published to the [NPM registry](https://www.npmjs.com/package/redux) as `redux-preboiled`. You can install it as usual via NPM or [Yarn](https://yarnpkg.com/).

```
# NPM
npm install redux-preboiled

# Yarn
yarn add redux-preboiled
```

TypeScript typings are provided out of the box - no additional typings package needed.

## Usage

Preboiled is just a collection of helper functions, so there is no required setup. Just import the helpers you need directly from the `redux-preboiled` module, for example:

```js
import { chainReducers, onAction } from 'redux-preboiled';
```

If you use a module bundler thats supports [tree shaking](https://developers.google.com/web/fundamentals/performance/optimizing-javascript/tree-shaking/) - such as [Webpack](https://webpack.js.org/) or [Rollup](https://rollupjs.org/) - only the helpers you actually use will end up in your application's build output. For instance, in a React app boostrapped with [Create React App](https://facebook.github.io/create-react-app/), this works out of the box.

## Next Steps

For a tour of Redux Preboiled, see the guides on the provided helpers for [actions](https://redux-preboiled.js.org/guides/actions), [reducers](https://redux-preboiled.js.org/guides/reducers) and [testing](https://redux-preboiled.js.org/guides/testing).
