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

Should we recommend npx create-book <directory> or with Yarn 2 yarn dlx create-book <directory> #9

Open
MurakamiShinyu opened this issue Aug 3, 2020 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@MurakamiShinyu
Copy link
Member

In the current README:

Just run yarn create book and start writing your book!

Use

yarn create book <directory>
# or
npm create book <directory>

I checked the Yarn 2 documentation - Migration - CLI Commands - Renamed and found that the yarn create in Yarn Classic (1.x) is replaced to yarn dlx create-<name> in Yarn 2 with Note: "yarn create still works, but prefer using yarn dlx".

If yarn create will be deprecated, we should not recommend yarn create and its npm counterpart npm create and should recommend npx and yarn dlx?

npx create-book <directory>   # same as `npm create book <directory>`
# or if Yarn 2 is available:
yarn dlx create-book <directory>
@MurakamiShinyu MurakamiShinyu added the documentation Improvements or additions to documentation label Aug 3, 2020
@akabekobeko akabekobeko self-assigned this Sep 13, 2020
@akabekobeko akabekobeko added this to the 1.0.0 milestone Jul 5, 2021
@akabekobeko akabekobeko modified the milestones: 1.0.0, v1.1.0 Jun 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants