From 364392b9d9f23bc5e00bdcdb6dd715a1e40c9b83 Mon Sep 17 00:00:00 2001 From: Ville Immonen Date: Wed, 31 Aug 2016 16:58:46 +0300 Subject: [PATCH] Add a more prominent link to the guide (#524) * 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. * Make the wording of links more obvious * Rename the "How Do I...?" section to "User Guide" for consistency --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fcc1f93e18e..2fa9f43d158 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ Create React apps with no build configuration. +* [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 ```sh @@ -81,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).