Skip to content

Update installation command#1184

Closed
jcubic wants to merge 1 commit intogoogle:mainfrom
jcubic:patch-1
Closed

Update installation command#1184
jcubic wants to merge 1 commit intogoogle:mainfrom
jcubic:patch-1

Conversation

@jcubic
Copy link

@jcubic jcubic commented Apr 6, 2025

Updating the installation command. If you install the package locally, you will not be able to use it as in example in README.

@google-cla
Copy link

google-cla bot commented Apr 6, 2025

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@jcubic
Copy link
Author

jcubic commented Apr 6, 2025

Signed CLA.

@antongolub
Copy link
Collaborator

antongolub commented Apr 6, 2025

@jcubic,

I've added extra notes on the CLI API. Take a look: #1185 Is this enough?

@jcubic
Copy link
Author

jcubic commented Apr 6, 2025

I think that the README can be self-contained, why not add -g tag and make it work out of the box without the need to read the docs? Right now when someone is new to NPM he will install it locally and the example will not work.

I would even go further and include information about installing Node.js. I always include this information in my projects. This is the same as with accessibility, you don't discriminate people that may not know what NPM is.

@antongolub
Copy link
Collaborator

antongolub commented Apr 6, 2025

Installing a package at the system level should be a conscious choice, and we certainly wouldn't want to push the -g flag on newbies, as you pointed out. That would be an abuse of trust, imo. zx strives to be as secure, transparent, verifiable and predictable as possible.

antonmedv pushed a commit that referenced this pull request Apr 6, 2025
* docs: mention `node --import` and impr CLI description

closes #1184

* docs: mention `npx` usage

* docs: add gh setup snippet

* docs: mention cross-platform
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

Successfully merging this pull request may close these issues.

2 participants