From 2dae428cfa984fae187c867a07777b78fd1fc1b3 Mon Sep 17 00:00:00 2001 From: Rafael Quijada Date: Sat, 1 Aug 2020 16:27:24 -0500 Subject: [PATCH] Updated README.md Templates to Follow ESLint Markdown Rules (#9241) --- .../template/README.md | 12 ++++++---- packages/cra-template/template/README.md | 24 ++++++++++--------- 2 files changed, 20 insertions(+), 16 deletions(-) diff --git a/packages/cra-template-typescript/template/README.md b/packages/cra-template-typescript/template/README.md index 74735dc6626..b87cb00449e 100644 --- a/packages/cra-template-typescript/template/README.md +++ b/packages/cra-template-typescript/template/README.md @@ -1,3 +1,5 @@ +# Getting Started with Create React App + This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). ## Available Scripts @@ -6,23 +8,23 @@ In the project directory, you can run: ### `npm start` -Runs the app in the development mode.
+Runs the app in the development mode.\ Open [http://localhost:3000](http://localhost:3000) to view it in the browser. -The page will reload if you make edits.
+The page will reload if you make edits.\ You will also see any lint errors in the console. ### `npm test` -Launches the test runner in the interactive watch mode.
+Launches the test runner in the interactive watch mode.\ See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. ### `npm run build` -Builds the app for production to the `build` folder.
+Builds the app for production to the `build` folder.\ It correctly bundles React in production mode and optimizes the build for the best performance. -The build is minified and the filenames include the hashes.
+The build is minified and the filenames include the hashes.\ Your app is ready to be deployed! See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. diff --git a/packages/cra-template/template/README.md b/packages/cra-template/template/README.md index 54ef09430b1..0c83cde2ce7 100644 --- a/packages/cra-template/template/README.md +++ b/packages/cra-template/template/README.md @@ -1,3 +1,5 @@ +# Getting Started with Create React App + This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). ## Available Scripts @@ -6,23 +8,23 @@ In the project directory, you can run: ### `npm start` -Runs the app in the development mode.
+Runs the app in the development mode.\ Open [http://localhost:3000](http://localhost:3000) to view it in the browser. -The page will reload if you make edits.
+The page will reload if you make edits.\ You will also see any lint errors in the console. ### `npm test` -Launches the test runner in the interactive watch mode.
+Launches the test runner in the interactive watch mode.\ See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. ### `npm run build` -Builds the app for production to the `build` folder.
+Builds the app for production to the `build` folder.\ It correctly bundles React in production mode and optimizes the build for the best performance. -The build is minified and the filenames include the hashes.
+The build is minified and the filenames include the hashes.\ Your app is ready to be deployed! See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. @@ -45,24 +47,24 @@ To learn React, check out the [React documentation](https://reactjs.org/). ### Code Splitting -This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting +This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) ### Analyzing the Bundle Size -This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size +This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) ### Making a Progressive Web App -This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app +This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) ### Advanced Configuration -This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration +This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) ### Deployment -This section has moved here: https://facebook.github.io/create-react-app/docs/deployment +This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) ### `npm run build` fails to minify -This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify +This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)