Skip to content

Commit

Permalink
Add a more prominent link to the guide (facebook#524)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
fson authored and gaearon committed Aug 31, 2016
1 parent a3f327a commit 364392b
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.<br>
Your app is ready to be deployed!

## How Do I…?
## User Guide

The generated project will include a guide in its README.<br>
You can also read its latest version [here](https://github.com/facebookincubator/create-react-app/blob/master/template/README.md).
Expand Down

0 comments on commit 364392b

Please sign in to comment.