Skip to content
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

Merged
merged 7 commits into from
Jun 20, 2018

Conversation

RusinovAnton
Copy link
Contributor

Added instructions for:

  • npm init react-app <name>
  • yarn create react-app <name>

closes #4478

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>`:
Copy link
Contributor

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)

Copy link
Contributor

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?

Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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+*

---
Copy link
Contributor

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.

@bugzpodder
Copy link

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.

@RusinovAnton
Copy link
Contributor Author

Hows that looking?

README.md Outdated
```sh
npm init react-app my-app
```
*`npm init <initializer>` is available since npm 6+*
Copy link
Contributor

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+*
Copy link
Contributor

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

@iansu
Copy link
Contributor

iansu commented Jun 20, 2018

I just requested a couple minor edits and then I think it's ready.

@RusinovAnton
Copy link
Contributor Author

@iansu ready

@iansu iansu added this to the 2.0.0 milestone Jun 20, 2018
@iansu iansu merged commit 26febc5 into facebook:next Jun 20, 2018
@iansu
Copy link
Contributor

iansu commented Jun 20, 2018

Thanks for the PR!

@RusinovAnton RusinovAnton deleted the update-readme-next branch June 21, 2018 10:17
@lock lock bot locked and limited conversation to collaborators Jan 19, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants