Skip to content

Commit 6142b79

Browse files
committed
Clean up Getting Started examples list
1 parent f45f3ec commit 6142b79

File tree

1 file changed

+8
-15
lines changed

1 file changed

+8
-15
lines changed

docs/introduction/GettingStarted.md

+8-15
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,11 @@ You can use Redux together with [React](https://reactjs.org), or with any other
1818
Redux is available as a package on NPM for use with a module bundler or in a Node application:
1919

2020
```bash
21+
# NPM
2122
npm install --save redux
23+
24+
# Yarn
25+
yarn add redux
2226
```
2327

2428
It is also available as a precompiled UMD package that defines a `window.Redux` global variable. The UMD package can be used as a [`<script>` tag](https://unpkg.com/redux/dist/redux.js) directly.
@@ -27,11 +31,11 @@ For more details, see the [Installation](Installation.md) page.
2731

2832
## Redux Toolkit
2933

30-
Redux itself is small and unopinionated. We also have a separate package called **[Redux Toolkit](https://redux-toolkit.js.org/)**,
34+
Redux itself is small and unopinionated. We also have a separate addon package called **[Redux Toolkit](https://redux-toolkit.js.org/)**,
3135
which includes some opinionated defaults that help you use Redux more effectively. It's our official recommended approach
3236
for writing Redux logic.
3337

34-
RTK includes utilities that help simplify a lot of common use cases, including [store setup](https://redux-toolkit.js.org/api/configureStore),
38+
RTK includes utilities that help simplify many common use cases, including [store setup](https://redux-toolkit.js.org/api/configureStore),
3539
[creating reducers and writing immutable update logic](https://redux-toolkit.js.org/api/createreducer),
3640
and even [creating entire "slices" of state at once](https://redux-toolkit-kit.js.org/api/createslice).
3741

@@ -99,20 +103,11 @@ In a typical Redux app, there is just a single store with a single root reducing
99103

100104
This architecture might seem like an overkill for a counter app, but the beauty of this pattern is how well it scales to large and complex apps. It also enables very powerful developer tools, because it is possible to trace every mutation to the action that caused it. You can record user sessions and reproduce them just by replaying every action.
101105

102-
## Examples
106+
## Example Projects
103107

104108
The Redux repository contains several example projects demonstrating various aspects of how to use Redux. Almost all examples have a corresponding CodeSandbox sandbox. This is an interactive version of the code that you can play with online.
105109

106-
- [**Counter Vanilla**](/introduction/examples#counter-vanilla): [Source](https://github.com/reduxjs/redux/tree/master/examples/counter-vanilla)
107-
- [**Counter**](/introduction/examples#counter): [Source](https://github.com/reduxjs/redux/tree/master/examples/counter) | [Sandbox](https://codesandbox.io/s/github/reduxjs/redux/tree/master/examples/counter)
108-
- [**Todos**](/introduction/examples#todos): [Source](https://github.com/reduxjs/redux/tree/master/examples/todos) | [Sandbox](https://codesandbox.io/s/github/reduxjs/redux/tree/master/examples/todos)
109-
- [**Todos with Undo**](/introduction/examples#todos-with-undo): [Source](https://github.com/reduxjs/redux/tree/master/examples/todos-with-undo) | [Sandbox](https://codesandbox.io/s/github/reduxjs/redux/tree/master/examples/todos-with-undo)
110-
- [**TodoMVC**](/introduction/examples#todomvc): [Source](https://github.com/reduxjs/redux/tree/master/examples/todomvc) | [Sandbox](https://codesandbox.io/s/github/reduxjs/redux/tree/master/examples/todomvc)
111-
- [**Shopping Cart**](/introduction/examples#shopping-cart): [Source](https://github.com/reduxjs/redux/tree/master/examples/shopping-cart) | [Sandbox](https://codesandbox.io/s/github/reduxjs/redux/tree/master/examples/shopping-cart)
112-
- [**Tree View**](/introduction/examples#tree-view): [Source](https://github.com/reduxjs/redux/tree/master/examples/tree-view) | [Sandbox](https://codesandbox.io/s/github/reduxjs/redux/tree/master/examples/tree-view)
113-
- [**Async**](/introduction/examples#async): [Source](https://github.com/reduxjs/redux/tree/master/examples/async) | [Sandbox](https://codesandbox.io/s/github/reduxjs/redux/tree/master/examples/async)
114-
- [**Universal**](/introduction/examples#universal): [Source](https://github.com/reduxjs/redux/tree/master/examples/universal)
115-
- [**Real World**](/introduction/examples#real-world): [Source](https://github.com/reduxjs/redux/tree/master/examples/real-world) | [Sandbox](https://codesandbox.io/s/github/reduxjs/redux/tree/master/examples/real-world)
110+
See the complete list of examples in the **[Examples page](./Examples.md)**.
116111

117112
## Learn Redux
118113

@@ -168,8 +163,6 @@ Here are some suggestions on when it makes sense to use Redux:
168163
- You need a single source of truth for your state
169164
- You find that keeping all your state in a top-level component is no longer sufficient
170165

171-
Yes, these guidelines are subjective and vague, but this is for good reason. The point at which you should integrate Redux into your application is different for every user and different for every application.
172-
173166
> **For more thoughts on how Redux is meant to be used, see:**<br>
174167
>
175168
> - **[Redux FAQ: When should I use Redux?](../faq/General.md#when-should-i-use-redux)**

0 commit comments

Comments
 (0)