From 73339052685ca5cf6d9cbdcac5ff727c6a51267c Mon Sep 17 00:00:00 2001 From: Ville Immonen Date: Wed, 31 Aug 2016 16:34:02 +0300 Subject: [PATCH 1/3] Add a more prominent link to the guide As a contributor, I know where to find the documentation/guide since know the codebase, but I've seen people miss the link to it in the README, because it's not very prominent. Let's try to make it more discoverable by including a link to it right on top of the page. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index fcc1f93e18e..e8ded5740ec 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ Create React apps with no build configuration. +* [Getting Started](#getting-started) +* [Guide](https://github.com/facebookincubator/create-react-app/blob/master/template/README.md) + ## tl;dr ```sh From 6361de5f1c1a1cf5233bb9e69fcfdeb3a115ef42 Mon Sep 17 00:00:00 2001 From: Ville Immonen Date: Wed, 31 Aug 2016 16:48:28 +0300 Subject: [PATCH 2/3] Make the wording of links more obvious --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e8ded5740ec..f81e092cde9 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ Create React apps with no build configuration. -* [Getting Started](#getting-started) -* [Guide](https://github.com/facebookincubator/create-react-app/blob/master/template/README.md) +* [Getting Started](#getting-started) – How to create a new app. +* [User Guide](https://github.com/facebookincubator/create-react-app/blob/master/template/README.md) – How to develop apps bootstrapped with Create React App. ## tl;dr From 17bea4976459d5c035fd6c978a5dcf520866fc72 Mon Sep 17 00:00:00 2001 From: Ville Immonen Date: Wed, 31 Aug 2016 16:56:41 +0300 Subject: [PATCH 3/3] Rename the "How Do I...?" section to "User Guide" for consistency --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f81e092cde9..2fa9f43d158 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ It correctly bundles React in production mode and optimizes the build for the be The build is minified and the filenames include the hashes.
Your app is ready to be deployed! -## How Do I…? +## User Guide The generated project will include a guide in its README.
You can also read its latest version [here](https://github.com/facebookincubator/create-react-app/blob/master/template/README.md).