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

Feature Request: Update README "Get Started" to include YARN details along with existing NPM details. #607

Closed
DaneTheory opened this issue Jan 13, 2019 · 2 comments

Comments

@DaneTheory
Copy link
Contributor

PROBLEM
Currently, the react-slingshot README section "Get Started" provides instruction details which assumes the user to be utilizing NPM as their preferred package-manager for Node. However, if the user follows the instructions as written, but utilizes YARN instead of NPM, then it is not immediately obvious what to do, and more importantly, the final step in the process fails. YARN does not recognize the -s flag to enable silent mode as NPM does, and instead requires a different flag of --silent to successfully enable silent mode on script run. See ADDITIONAL CONTEXT for broader explanation as to why this is a relevant problem that should be fixed.

SOLUTION
Update README section "Get Started" to include the the NPM equivalent YARN scripts alongside the already provided NPM scripts listed.

ALTERNATIVES
Seems like this is pretty straight forward.

ADDITIONAL CONTEXT
React-Slingshot supports YARN already. Can't see why this wasn't just included when support was added.
See: #319 and #292

@nickytonline
Copy link
Collaborator

Thanks for the feature request @DaneTheory. PRs are definitely welcome for updating the docs!

@nickytonline
Copy link
Collaborator

Closing as per comments in #610.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants