Skip to content

Commit 68e9daa

Browse files
committed
Update README
1 parent cefa926 commit 68e9daa

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
1-
# Redux Starter Kit
1+
# Redux Toolkit
22

3-
[![build status](https://img.shields.io/travis/reduxjs/redux-starter-kit/master.svg?style=flat-square)](https://travis-ci.org/reduxjs/redux-starter-kit)
3+
[![build status](https://img.shields.io/travis/reduxjs/redux-toolkit/master.svg?style=flat-square)](https://travis-ci.org/reduxjs/redux-toolkit)
44

5-
[![npm version](https://img.shields.io/npm/v/redux-starter-kit.svg?style=flat-square)](https://www.npmjs.com/package/redux-starter-kit)
5+
[![npm version](https://img.shields.io/npm/v/@reduxjs/toolkit.svg?style=flat-square)](https://www.npmjs.com/package/@reduxjs/toolkit)
66

7-
[![npm downloads](https://img.shields.io/npm/dm/redux-starter-kit.svg?style=flat-square)](https://www.npmjs.com/package/redux-starter-kit)
7+
[![npm downloads](https://img.shields.io/npm/dm/@reduxjs/toolkit.svg?style=flat-square)](https://www.npmjs.com/package/@reduxjs/toolkit)
88

9-
**A simple set of tools to make using Redux easier**
9+
**The official, opinionated, batteries-included toolset for efficient Redux development**
1010

11-
`npm install redux-starter-kit`
11+
`npm install @reduxjs/toolkit`
1212

13-
(Special thanks to Github user @shotak for donating to the package name.)
13+
(Formerly known as "Redux Starter Kit")
1414

1515
### Purpose
1616

17-
The Redux Starter Kit package is intended to help address three common concerns about Redux:
17+
The **Redux Toolkit** package is intended to be the standard way to write Redux logic. It was originally created to help address three common concerns about Redux:
1818

1919
- "Configuring a Redux store is too complicated"
2020
- "I have to add a lot of packages to get Redux to do anything useful"
2121
- "Redux requires too much boilerplate code"
2222

2323
We can't solve every use case, but in the spirit of [`create-react-app`](https://github.com/facebook/create-react-app) and [`apollo-boost`](https://dev-blog.apollodata.com/zero-config-graphql-state-management-27b1f1b3c2c3), we can try to provide some tools that abstract over the setup process and handle the most common use cases, as well as include some useful utilities that will let the user simplify their application code.
2424

25-
This package is _not_ intended to solve every possible concern about Redux, and is deliberately limited in scope. It does _not_ address concepts like "reusable encapsulated Redux modules", data fetching, folder or file structures, managing entity relationships in the store, and so on.
25+
This package is _not_ intended to solve every possible use case for Redux, and is deliberately limited in scope. It does _not_ address concepts like "reusable encapsulated Redux modules", data fetching, folder or file structures, managing entity relationships in the store, and so on.
2626

2727
### What's Included
2828

29-
Redux Starter Kit includes:
29+
Redux Toolkit includes:
3030

3131
- A `configureStore()` function with simplified configuration options. It can automatically combine your slice reducers, adds whatever Redux middleware you supply, includes `redux-thunk` by default, and enables use of the Redux DevTools Extension.
3232
- A `createReducer()` utility that lets you supply a lookup table of action types to case reducer functions, rather than writing switch statements. In addition, it automatically uses the [`immer` library](https://github.com/mweststrate/immer) to let you write simpler immutable updates with normal mutative code, like `state.todos[3].completed = true`.
@@ -36,6 +36,4 @@ Redux Starter Kit includes:
3636

3737
## Documentation
3838

39-
The Redux Starter Kit docs are now published at **https://redux-starter-kit.js.org**.
40-
41-
We're currently expanding and rewriting our docs content - check back soon for more updates!
39+
The Redux Toolkit docs are available at **https://redux-toolkit.js.org**.

0 commit comments

Comments
 (0)