Skip to content

Comments

Simplify usage and docs#175

Merged
marcelklehr merged 4 commits intomasterfrom
feature/simplify-usage-and-docs
Oct 18, 2016
Merged

Simplify usage and docs#175
marcelklehr merged 4 commits intomasterfrom
feature/simplify-usage-and-docs

Conversation

@marcelklehr
Copy link
Member

Fixes #172

please provide feedback! :)

1. version requirements are what you set
2. versions are what you install
README.md Outdated
> nodist npm 3.x
# Globally activate npm 3
> nodist global npm 3.x
# Set global node version requirement.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be
"Sets the global npm version requirement."

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, yes.

usage.txt Outdated
nodist run <version> -- <args..> Run <args> with the specified node version
nodist r <version> -- <args..> (downloads the executable, if necessary).
nodist run <ver-req> -- <args> Run <args> with a version matching the provided requirement.
nodist r <ver-req> -- <args> (Will abort if no matching version is installed)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would either lowercase "Will" or capitalize the first word in the subsequent parentheticals. Also missing period here and on line 40.

@nwayve
Copy link

nwayve commented Oct 18, 2016

Some minor details in the usage.txt but overall I think these are good updates to the docs.

@nwayve
Copy link

nwayve commented Oct 18, 2016

👍

@marcelklehr marcelklehr merged commit e7f7a58 into master Oct 18, 2016
@marcelklehr
Copy link
Member Author

Thanks! :)

@Mairu Mairu deleted the feature/simplify-usage-and-docs branch December 8, 2023 07:08
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