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

Refine the install section in README #214

Merged

Conversation

augustobmoura
Copy link
Member

After npm/cli#2872 I thought it would be more useful to have a more concise install section

What I did:

@augustobmoura
Copy link
Member Author

@Stratus3D I'm merging this PR, because is just some minors adjustments in README, tagging you just for information

@augustobmoura augustobmoura merged commit b38dda3 into asdf-vm:master Apr 12, 2021
@Stratus3D
Copy link
Member

Thanks @augustobmoura ! Changes here look good. Sorry I didn't merge it for you. One thing to note that you might consider reverting:

There is some inherit risk for users in installing and running plugins on their system. One of the ways I try to reduce the risk is by making it clear what is going on behind the scenes. We've intentionally kept the long plugin-add syntax in readmes and other docs because it clearly shows where the code is coming from (users sees it's a git repo named asdf-vm/asdf-nodejs):

asdf plugin-add nodejs https://github.com/asdf-vm/asdf-nodejs.git

This syntax also allows the user to easily change the name to something other than nodejs by specifying any other value.

@augustobmoura
Copy link
Member Author

Makes sense to me, I will open a new PR to revert this change

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