-
-
Notifications
You must be signed in to change notification settings - Fork 26.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add instructions on alternative methods of app creation #4638
Conversation
README.md
Outdated
```sh | ||
npx create-react-app my-app | ||
``` | ||
|
||
*([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))* | ||
|
||
### npm init | ||
|
||
Since npm of 6+ `npm init <name> <...args>` command may be used as an alias for `npx create-<name> <...args>`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some of this information is unnecessary, can we make it more in line with the npx
header?
npm
npm init react-app my-app
(npm init comes with npm 6+ and higher, see instructions for older npm versions)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we even need this section if they have npm 5+?
Should we only recommend npx
since it's available in both npm 5/6?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it makes sense to recommend it as an alternative as long as we're clear that it's only available in npm 6+.
README.md
Outdated
npm init react-app my-app | ||
``` | ||
|
||
### yarn create |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please capitalize Yarn and cut the create
:
Yarn
yarn create react-app my-app
(yarn create comes with Yarn 0.25+ and higher, otherwise see instructions for npm)
README.md
Outdated
|
||
```sh | ||
npx create-react-app my-app | ||
``` | ||
|
||
*([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))* | ||
|
||
### NPM |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
npm should be lowercase.
README.md
Outdated
``` | ||
*`yarn create` command is available since Yarn 0.25+* | ||
|
||
--- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was this line here before? I think it should be removed.
One thing I've noticed is that if you have create-react-app installed to a previous version (eg 1.4.1) npx and npm init will just use that version instead of latest. |
Hows that looking? |
README.md
Outdated
```sh | ||
npm init react-app my-app | ||
``` | ||
*`npm init <initializer>` is available since npm 6+* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change since
to in
README.md
Outdated
```sh | ||
yarn create react-app my-app | ||
``` | ||
*`yarn create` command is available since Yarn 0.25+* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change since
to in
and remove the word command
I just requested a couple minor edits and then I think it's ready. |
@iansu ready |
Thanks for the PR! |
Added instructions for:
npm init react-app <name>
yarn create react-app <name>
closes #4478