Skip to content

Commit fd2ef49

Browse files
committed
Rewrite example READMEs to say "Outdated, see docs"
1 parent d26497d commit fd2ef49

File tree

8 files changed

+26
-231
lines changed

8 files changed

+26
-231
lines changed

examples/async/README.md

+3-33
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,5 @@
11
# Redux Async Example
22

3-
This project template was built with [Create React App](https://github.com/facebookincubator/create-react-app), which provides a simple way to start React projects with no build configuration needed.
4-
5-
Projects built with Create-React-App include support for ES6 syntax, as well as several unofficial / not-yet-final forms of Javascript syntax such as Class Properties and JSX. See the list of [language features and polyfills supported by Create-React-App](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#supported-language-features-and-polyfills) for more information.
6-
7-
## Available Scripts
8-
9-
In the project directory, you can run:
10-
11-
### `npm start`
12-
13-
Runs the app in the development mode.<br>
14-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
15-
16-
The page will reload if you make edits.<br>
17-
You will also see any lint errors in the console.
18-
19-
### `npm run build`
20-
21-
Builds the app for production to the `build` folder.<br>
22-
It correctly bundles React in production mode and optimizes the build for the best performance.
23-
24-
The build is minified and the filenames include the hashes.<br>
25-
Your app is ready to be deployed!
26-
27-
### `npm run eject`
28-
29-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
30-
31-
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
32-
33-
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
34-
35-
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
3+
> **Warning**: This example is outdated, and shows legacy patterns that we no longer teach or recommend.
4+
> Please see the Redux docs tutorials for our recommended usage patterns, and specifically the "Essentials" tutorial:
5+
> **https://redux.js.org/tutorials/index**

examples/real-world/README.md

+3-33
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,5 @@
11
# Redux Real World Example
22

3-
This project template was built with [Create React App](https://github.com/facebookincubator/create-react-app), which provides a simple way to start React projects with no build configuration needed.
4-
5-
Projects built with Create-React-App include support for ES6 syntax, as well as several unofficial / not-yet-final forms of Javascript syntax such as Class Properties and JSX. See the list of [language features and polyfills supported by Create-React-App](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#supported-language-features-and-polyfills) for more information.
6-
7-
## Available Scripts
8-
9-
In the project directory, you can run:
10-
11-
### `npm start`
12-
13-
Runs the app in the development mode.<br>
14-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
15-
16-
The page will reload if you make edits.<br>
17-
You will also see any lint errors in the console.
18-
19-
### `npm run build`
20-
21-
Builds the app for production to the `build` folder.<br>
22-
It correctly bundles React in production mode and optimizes the build for the best performance.
23-
24-
The build is minified and the filenames include the hashes.<br>
25-
Your app is ready to be deployed!
26-
27-
### `npm run eject`
28-
29-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
30-
31-
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
32-
33-
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
34-
35-
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
3+
> **Warning**: This example is outdated, and shows legacy patterns that we no longer teach or recommend.
4+
> Please see the Redux docs tutorials for our recommended usage patterns, and specifically the "Essentials" tutorial:
5+
> **https://redux.js.org/tutorials/index**

examples/shopping-cart/README.md

+3-33
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,5 @@
11
# Redux Shopping Cart Example
22

3-
This project template was built with [Create React App](https://github.com/facebookincubator/create-react-app), which provides a simple way to start React projects with no build configuration needed.
4-
5-
Projects built with Create-React-App include support for ES6 syntax, as well as several unofficial / not-yet-final forms of Javascript syntax such as Class Properties and JSX. See the list of [language features and polyfills supported by Create-React-App](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#supported-language-features-and-polyfills) for more information.
6-
7-
## Available Scripts
8-
9-
In the project directory, you can run:
10-
11-
### `npm start`
12-
13-
Runs the app in the development mode.<br>
14-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
15-
16-
The page will reload if you make edits.<br>
17-
You will also see any lint errors in the console.
18-
19-
### `npm run build`
20-
21-
Builds the app for production to the `build` folder.<br>
22-
It correctly bundles React in production mode and optimizes the build for the best performance.
23-
24-
The build is minified and the filenames include the hashes.<br>
25-
Your app is ready to be deployed!
26-
27-
### `npm run eject`
28-
29-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
30-
31-
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
32-
33-
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
34-
35-
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
3+
> **Warning**: This example is outdated, and shows legacy patterns that we no longer teach or recommend.
4+
> Please see the Redux docs tutorials for our recommended usage patterns, and specifically the "Essentials" tutorial:
5+
> **https://redux.js.org/tutorials/index**

examples/todomvc/README.md

+3-33
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,5 @@
11
# Redux TodoMVC Example
22

3-
This project template was built with [Create React App](https://github.com/facebookincubator/create-react-app), which provides a simple way to start React projects with no build configuration needed.
4-
5-
Projects built with Create-React-App include support for ES6 syntax, as well as several unofficial / not-yet-final forms of Javascript syntax such as Class Properties and JSX. See the list of [language features and polyfills supported by Create-React-App](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#supported-language-features-and-polyfills) for more information.
6-
7-
## Available Scripts
8-
9-
In the project directory, you can run:
10-
11-
### `npm start`
12-
13-
Runs the app in the development mode.<br>
14-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
15-
16-
The page will reload if you make edits.<br>
17-
You will also see any lint errors in the console.
18-
19-
### `npm run build`
20-
21-
Builds the app for production to the `build` folder.<br>
22-
It correctly bundles React in production mode and optimizes the build for the best performance.
23-
24-
The build is minified and the filenames include the hashes.<br>
25-
Your app is ready to be deployed!
26-
27-
### `npm run eject`
28-
29-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
30-
31-
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
32-
33-
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
34-
35-
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
3+
> **Warning**: This example is outdated, and shows legacy patterns that we no longer teach or recommend.
4+
> Please see the Redux docs tutorials for our recommended usage patterns, and specifically the "Essentials" tutorial:
5+
> **https://redux.js.org/tutorials/index**

examples/todos-with-undo/README.md

+3-33
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,5 @@
11
# Redux Todos with Undo Example
22

3-
This project template was built with [Create React App](https://github.com/facebookincubator/create-react-app), which provides a simple way to start React projects with no build configuration needed.
4-
5-
Projects built with Create-React-App include support for ES6 syntax, as well as several unofficial / not-yet-final forms of Javascript syntax such as Class Properties and JSX. See the list of [language features and polyfills supported by Create-React-App](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#supported-language-features-and-polyfills) for more information.
6-
7-
## Available Scripts
8-
9-
In the project directory, you can run:
10-
11-
### `npm start`
12-
13-
Runs the app in the development mode.<br>
14-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
15-
16-
The page will reload if you make edits.<br>
17-
You will also see any lint errors in the console.
18-
19-
### `npm run build`
20-
21-
Builds the app for production to the `build` folder.<br>
22-
It correctly bundles React in production mode and optimizes the build for the best performance.
23-
24-
The build is minified and the filenames include the hashes.<br>
25-
Your app is ready to be deployed!
26-
27-
### `npm run eject`
28-
29-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
30-
31-
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
32-
33-
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
34-
35-
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
3+
> **Warning**: This example is outdated, and shows legacy patterns that we no longer teach or recommend.
4+
> Please see the Redux docs tutorials for our recommended usage patterns, and specifically the "Essentials" tutorial:
5+
> **https://redux.js.org/tutorials/index**

examples/todos/README.md

+3-33
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,5 @@
11
# Redux Todos Example
22

3-
This project template was built with [Create React App](https://github.com/facebookincubator/create-react-app), which provides a simple way to start React projects with no build configuration needed.
4-
5-
Projects built with Create-React-App include support for ES6 syntax, as well as several unofficial / not-yet-final forms of Javascript syntax such as Class Properties and JSX. See the list of [language features and polyfills supported by Create-React-App](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#supported-language-features-and-polyfills) for more information.
6-
7-
## Available Scripts
8-
9-
In the project directory, you can run:
10-
11-
### `npm start`
12-
13-
Runs the app in the development mode.<br>
14-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
15-
16-
The page will reload if you make edits.<br>
17-
You will also see any lint errors in the console.
18-
19-
### `npm run build`
20-
21-
Builds the app for production to the `build` folder.<br>
22-
It correctly bundles React in production mode and optimizes the build for the best performance.
23-
24-
The build is minified and the filenames include the hashes.<br>
25-
Your app is ready to be deployed!
26-
27-
### `npm run eject`
28-
29-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
30-
31-
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
32-
33-
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
34-
35-
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
3+
> **Warning**: This example is outdated, and shows legacy patterns that we no longer teach or recommend.
4+
> Please see the Redux docs tutorials for our recommended usage patterns, and specifically the "Essentials" tutorial:
5+
> **https://redux.js.org/tutorials/index**

examples/tree-view/README.md

+3-33
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,5 @@
11
# Redux Tree View Example
22

3-
This project template was built with [Create React App](https://github.com/facebookincubator/create-react-app), which provides a simple way to start React projects with no build configuration needed.
4-
5-
Projects built with Create-React-App include support for ES6 syntax, as well as several unofficial / not-yet-final forms of Javascript syntax such as Class Properties and JSX. See the list of [language features and polyfills supported by Create-React-App](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#supported-language-features-and-polyfills) for more information.
6-
7-
## Available Scripts
8-
9-
In the project directory, you can run:
10-
11-
### `npm start`
12-
13-
Runs the app in the development mode.<br>
14-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
15-
16-
The page will reload if you make edits.<br>
17-
You will also see any lint errors in the console.
18-
19-
### `npm run build`
20-
21-
Builds the app for production to the `build` folder.<br>
22-
It correctly bundles React in production mode and optimizes the build for the best performance.
23-
24-
The build is minified and the filenames include the hashes.<br>
25-
Your app is ready to be deployed!
26-
27-
### `npm run eject`
28-
29-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
30-
31-
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
32-
33-
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
34-
35-
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
3+
> **Warning**: This example is outdated, and shows legacy patterns that we no longer teach or recommend.
4+
> Please see the Redux docs tutorials for our recommended usage patterns, and specifically the "Essentials" tutorial:
5+
> **https://redux.js.org/tutorials/index**

examples/universal/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Redux Universal Client/Server Example
2+
3+
> **Warning**: This example is outdated, and shows legacy patterns that we no longer teach or recommend.
4+
> Please see the Redux docs tutorials for our recommended usage patterns, and specifically the "Essentials" tutorial:
5+
> **https://redux.js.org/tutorials/index**

0 commit comments

Comments
 (0)